FIX: Fixed documentation of bindings with modifiers and UI Toolkit tooltips in the asset editor (ISBX-806) #2048
Conversation
…s in the asset editor - Fixed tooltip support in the UI Toolkit version of the Input Actions Asset editor. - Fixed documentation to clarify bindings with modifiers `overrideModifiersNeedToBePressedFirst` configuration [ISXB-806](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-806).
| /// goes into pressed state for the composite as a whole to trigger. This means that binding to, for example, <c>Shift+B</c>, | ||
| /// the <c>shift</c> key has to be pressed before pressing the <c>B</c> key. This is the behavior usually expected with | ||
| /// keyboard shortcuts. | ||
| /// | ||
| /// This parameter can be used to bypass this behavior and allow any timing between <see cref="modifier"/> and <see cref="button"/>. | ||
| /// The only requirement is for them both to concurrently be in pressed state. | ||
| /// </remarks> | ||
| [Tooltip("If checked, it will bypass the InputSettings.shortcutKeysConsumeInput setting and the modifier can be pressed after and the composite will still trigger")] |
There was a problem hiding this comment.
Is that correct? It sounds like the reverse logic to my reading of the variable.
I think this is the state:
// Ordering important
overrideModifiersNeedToBePressedFirst = true
// Ordering not important
overrideModifiersNeedToBePressedFirst = false
If that's not the case then the variable and text next to the checkbox would also need changing.
There was a problem hiding this comment.
Current state is :
if InputSettings.shortcutKeysConsumeInput is false (the default)
// Ordering not important in all case
if InputSettings.shortcutKeysConsumeInput is true
// Ordering important
overrideModifiersNeedToBePressedFirst = false
// Ordering not important
overrideModifiersNeedToBePressedFirst = true
the name overrideModifiersNeedToBePressedFirst override the setting and doesn't really describe the composite behavior.
There was a problem hiding this comment.
Wow that's confusing. Making it clearer with the tooltip is helpful but I'd prefer if we tidied this up further to make it much more intuitive.
|
I see the tooltips just fine on one and two modifiers but I'm not even sure I understand the tooltip correctly it seems confusing. Maybe adding Ben is a good idea to proof read? My suggestion would be to change it to: I renamed the setting from a script one to the settings one, that I assume will be more familiar to people and rephrased it a bit. |
Description
The documentation of
overrideModifiersNeedToBePressedFirstwas not very clear and lead to miss configuration. https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-806I added a Tooltip in the UI and fixed the Tooltips support for UI Toolkit version of the Input Actions Asset editor.
Please note that there is currently a limitation within UI Toolkit that doesn't display tooltip if the label of the field is truncated.
Testing status & QA
Tested on windows 6000.0.26f1
Overall Product Risks
Please rate the potential complexity and halo effect from low to high for the reviewers. Note down potential risks to specific Editor branches if any.
Comments to reviewers
Please describe any additional information such as what to focus on, or historical info for the reviewers.
Checklist
Before review:
Changed,Fixed,Addedsections.Area_CanDoX,Area_CanDoX_EvenIfYIsTheCase,Area_WhenIDoX_AndYHappens_ThisIsTheResult.During merge:
NEW: ___.FIX: ___.DOCS: ___.CHANGE: ___.RELEASE: 1.1.0-preview.3.After merge: