DOCS: Update UI Support with project wide actions #1815
Conversation
lyndon-unity
left a comment
lyndon-unity
left a comment
There was a problem hiding this comment.
Small changed needed regarding the 1.8 reference in the URL link
|
|
||
| You can add and remove bindings as intended for you necessary functionality. However, the action map 'UI' and all of its actions must remain with the same name, otherwise the UI input will not work correctly. | ||
|
|
||
| The actions names are equivalent in functionality to the ones present in [InputSystemUIInputModule](../api/UnityEngine.InputSystem.UI.InputSystemUIInputModule.html). |
There was a problem hiding this comment.
You could mention that if you accidently delete the action map, using the 'reset' button will restore the defaults (but will impact the other actions maps in the project wide input actions).
Might not be needed to be explicitly stated here.
jfreire-unity
force-pushed
the
isx-1694-uitk-project-wide-actions-docs-update
branch
from
4065ffe to
7fb0239
Compare
lyndon-unity
left a comment
lyndon-unity
left a comment
There was a problem hiding this comment.
Changes look good.
Happy to approve.
However there are a couple of test failures on CI - I've clicked re-run on those to move it along as it looked like potentially infrastructure issues
Looks like develop is failing the same issue so not new in this PR |
|
Benoit Approved via slack due to login issues. |
lyndon-unity
left a comment
lyndon-unity
left a comment
There was a problem hiding this comment.
Generally good - but I'd advise one small change.
|
|
||
|  | ||
|
|
||
| You can modify, add, or remove bindings to the named actions in the UI action map to suit your project, however in order to remain compatible with UI Toolkit, the name of the action map ("UI") and the names of the actions it contains ("Navigate", "Submit", "Cancel", etc) must remain the same. This is because the actions names match the action property names in the [UI Input Module](../api/UnityEngine.InputSystem.UI.InputSystemUIInputModule.html) class. |
There was a problem hiding this comment.
This part isn't quite right - I think you can drop the ' This is because' part and it would be more correct.
This is because the actions names match the action property names in the UI Input Module class.
The are the same but that';s not what we are matching against.
There was a problem hiding this comment.
An attempt to modify this is coming in pending commit.
|
I will try to pick up this PR from @jfreire-unity |
lyndon-unity
left a comment
lyndon-unity
left a comment
There was a problem hiding this comment.
I'm happy with that update
Description
https://jira.unity3d.com/browse/ISX-1694
Changes made
Update public docs with changes made in #1807.
Notes
Might need an additional iteration on the whole docs. I did the minimum I believe is needed to be done. Feel free to edit this PR to change the docs. cc @duckets
Also, I believe there are some updates to be done by the UI team in https://docs.unity3d.com/Manual/UIE-Runtime-Event-System.html. I have informed them.
Checklist
Before review:
Changed,Fixed,Addedsections.([case %number%](https://issuetracker.unity3d.com/issues/...)).Area_CanDoX,Area_CanDoX_EvenIfYIsTheCase,Area_WhenIDoX_AndYHappens_ThisIsTheResult.During merge:
NEW: ___.FIX: ___.DOCS: ___.CHANGE: ___.RELEASE: 1.1.0-preview.3.