DOCF-5908 - "UI Support" content model re-org #2117
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Split content onto separate pages to apply content model. Removed old placeholder files.
|
|
jo-unity
reviewed
Feb 3, 2025
|
|
||
| |**Topic**|**Description**| | ||
| |--------|-----------| | ||
| |[Supported UI systems](supported-ui-systems.md)|Understand the compatibility between the Input System and Unity's UI systems.| |
There was a problem hiding this comment.
Minor thing but might create inconsistencies - I've been using the template here which bolds each entry in the table https://webcix-hexadocs-content-ops.vercel.app/internal/content-ops/en-us/documentation/content-model/um-landing-page-template
Comment on lines
2
to
4
| Unity has [three major UI solutions](https://docs.unity3d.com/Manual/UIToolkits.html). The Input System package's compatibility and workflow with these solutions varies depending on which UI solution you are using, and which version of Unity you are using. | ||
|
|
||
| The three main UI systems are **UI Toolkit**, **Unity UI**, and **IMGUI**. Some systems and versions require that you use the Input System’s [UI Input Module component](using-ui-input-module.md) to pass actions from the Input System to the UI. |
There was a problem hiding this comment.
I wonder whether reorganising this so it reads as a bullet point list with links to each heading in this doc might work better?
There was a problem hiding this comment.
I did consider this, but I wasn't sure if the links might be confusing. A link with the text "UI Toolkit" could link to the relevant section of this page, OR to the documentation on UI Toolkit.
| @@ -0,0 +1,58 @@ | |||
| # Understand UI system compatibility | |||
| Unity has [three major UI solutions](https://docs.unity3d.com/Manual/UIToolkits.html). The Input System package's compatibility and workflow with these solutions varies depending on which UI solution you are using, and which version of Unity you are using. | |||
There was a problem hiding this comment.
I wonder whether this intro would work better as a bullet point list with links to each heading in the doc
Packages/com.unity.inputsystem/Documentation~/supported-ui-input-types-pointer.md
Outdated
Show resolved
Hide resolved
Comment on lines
7
to
9
| Multiple pointer Devices can feed input into a single UI input module. Also, in the case of [Touchscreen](../api/UnityEngine.InputSystem.Touchscreen.html), a single Device can have the ability to have multiple concurrent pointers (each finger contact is one pointer). | ||
|
|
||
| Because multiple pointer Devices can feed into the same set of Actions, it is important to set the [action type](./RespondingToActions.md#action-types) to [PassThrough](../api/UnityEngine.InputSystem.InputActionType.html#UnityEngine_InputSystem_InputActionType_PassThrough). This ensures that no filtering is applied to input on these actions and that instead every input is relayed as is. |
There was a problem hiding this comment.
device and action need lowercase iirc
Packages/com.unity.inputsystem/Documentation~/introduction-on-screen-controls.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/create-on-screen-stick-control.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/create-on-screen-stick-control.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/create-custom-on-screen-control.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/create-custom-on-screen-control.md
Outdated
Show resolved
Hide resolved
duckets
requested changes
Feb 5, 2025
Packages/com.unity.inputsystem/Documentation~/handling-input-target-ambiguity.md
Outdated
Show resolved
Hide resolved
duckets
requested changes
Feb 5, 2025
|
|
||
| The default [project-wide actions asset](./about-project-wide-actions.md) comes with a built-in action map named **UI**, which contains all the actions required for UI interaction. To configure the bindings for these actions, use the [Actions Editor](./actions-editor.md). | ||
|
|
||
| To open the Actions Editor: |
There was a problem hiding this comment.
Suggested change
| To open the Actions Editor: | |
| To open the UI action map: |
siobhan-unity
commented
Feb 10, 2025
Packages/com.unity.inputsystem/Documentation~/understand-ui-compatibility.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Ben Pitt <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Content model re-org for the Input System's UI Input section.
Testing status & QA
Local build successful.