Version: 2018.3 (switch to 2019.1)
LanguageEnglish
  • C#

Input.imeCompositionMode

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

public static IMECompositionMode imeCompositionMode;

Description

Controls enabling and disabling of IME input composition.

Some languages use complex input methods which involve opening windows to insert characters. Typically, this is not desirable while playing a game, as games may just interpret key strokes as game input, not as text. By default, Unity will enable IME composition when in text fields, and disable it otherwise. However, when you want to implement your own input GUI, you may want to have control over this yourself, which is possible using the imeCompositionMode property. Set it to Auto for the default behavior, or On or Off to explicitly enable or disable IME composition.

Did you find this page useful? Please give it a rating: