Skip to content

Modified onIMECompositionChange documentation to bring clarity to intended usage #1755

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 9, 2023
Merged

Modified onIMECompositionChange documentation to bring clarity to intended usage #1755

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6387c21
Modified the documentation for onIMECompositionChange to clear up rel…
Secticide Sep 27, 2023
73117ff
Added changelog entry
Secticide Sep 28, 2023
d7436ee
Merge branch 'develop' into ISXB-628-IME-Composition-Event-Docs
Secticide Oct 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Packages/com.unity.inputsystem/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ however, it has to be formatted properly to pass verification tests.
- Fixed case [ISXB-251](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-251) (Action only calls started & performed callbacks when control type is set to Vector3Composite). `EvaluateMagnitude` wasn't overridden for Vector3Composite, also made some minor changes to Vector3Composite and Vector2Composite for consistency.
- Fixed case [ISXB-580](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-580) (UI Submit / Cancel not working with Switch Pro controller) by adding "Submit" & "Cancel" usages to the Switch Pro controller input controls.
- Fixed an issue where undoing deletion of Action Maps did not restore Actions correctly.
- Fixed case [ISXB-628](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-628) (OnIMECompositionChange does not return an empty string on accept when using Microsoft IME) by clarifying expectations and intended usage for the IME composition change event.

## [1.8.0-pre.1] - 2023-09-04

Expand Down
8 changes: 6 additions & 2 deletions Packages/com.unity.inputsystem/InputSystem/Devices/Keyboard.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -959,13 +959,17 @@ public event Action<char> onTextInput
}

/// <summary>
/// An event that is fired to get IME composition strings. Fired once for every change,
/// sends the entire string to date, and sends a blank string whenever a composition is submitted or reset.
/// An event that is fired to get IME composition strings. Fired once for every change containing the entire string to date.
/// When using an IME, this event can be used to display the composition string while it is being edited. When a composition
/// string is submitted, one or many <see cref="Keyboard.OnTextInput"/> events will fire with the submitted characters.
/// </summary>
/// <remarks>
/// 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.
///
/// Many IMEs cause this event to fire with a blank string when the composition is submitted or reset, however it is best
/// not to rely on this behaviour since it is IME dependent.
///
/// See <see cref="Keyboard.SetIMEEnabled"/> for turning IME on/off
/// </remarks>
public event Action<IMECompositionString> onIMECompositionChange
Expand Down