Version: Unity 6 (6000.0)
LanguageEnglish
  • C#
Method group is Obsolete

Input.eatKeyPressOnTextFieldFocus

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Obsolete eatKeyPressOnTextFieldFocus property is deprecated, and only provided to support legacy behavior. public static bool eatKeyPressOnTextFieldFocus;

Description

Property indicating whether keypresses are eaten by a textinput if it has focus (default true).

Note: This API is part of the legacy Input class, and not recommended for new projects. The documentation is provided here to support legacy projects that use the old Input Manager and Input class. For new projects you should use the newer and Input System Package. (read more).

This will avoid keypresses seeping through to the underlying gameview. This property must be set to false for anyKey or GetKey to work while a textfield has focus. IME input in the macOS web plugin is disabled when this is set to false.