Skip to content

Commit 01326cb

Browse files
smnwttbrducketsekcoh
authored
DOCS: ISXB-621 input system UI input module enables referenced UI action map (#1944)
* Update UISupport.md clarified doc text about UI Input Module component --------- Co-authored-by: Ben Pitt <[email protected]> Co-authored-by: Håkan Sidenvall <[email protected]>
1 parent 34d2cca commit 01326cb

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

Packages/com.unity.inputsystem/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ however, it has to be formatted properly to pass verification tests.
4747
### Added
4848
- Documentation to clarify effects of ordering of interactions when a single action has multiple interactions [ISXB-221](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-221).
4949
- Additional tests for UI Input default actions (Navigate, Submit, Scroll etc.)
50+
- Documented behaviour of InputSystemUIInputModule automatically enabling the UI action map. [ISXB-621](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-621)
5051

5152
### Fixed
5253
- Fixed an issue where UI interactions would not function without setting up a project-wide actions asset in Project Settings. Default UI actions are now created on the fly, if no asset for project-wide actions has been set. [ISXB-811](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-811).

Packages/com.unity.inputsystem/Documentation~/UISupport.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ You can also reset the UI action map to its default bindings by selecting **Rese
8383
## The UI Input Module component
8484

8585
When working with Unity UI (uGUI), or when using UI Toolkit in versions of Unity prior to Unity 2023.2, you must use the **UI Input Module** component which defines which actions are passed through to your UI, as well as some other UI-related input settings.
86+
> **Note:**
87+
> If you have an instance of the [Input System UI Input Module](../api/UnityEngine.InputSystem.UI.InputSystemUIInputModule.html) component in your scene, the settings on that component takes priority and are used instead of the UI settings in your project-wide actions. Also, The UI action map will be enabled, along with the default action map specified on any UI Input Module component in the scene.
8688
8789
The UI Input module is implemented in the class [`InputSystemUIInputModule`](../api/UnityEngine.InputSystem.UI.InputSystemUIInputModule.html).
8890

0 commit comments

Comments
 (0)