DOCS: updated Interactions doc with tips for multi-interactions #1912
Conversation
|
|
There was a problem hiding this comment.
Looks good to be. I would suggest adding a CHANGELOG.md entry apart from the minor comment. Also PR needs to be converted from Draft into regular PR to signal its ready. Also link the public bug URL in the changelog message (see examples from existing entries).
| @@ -79,6 +79,8 @@ If multiple Interactions are present on a single Binding or Action, then the Inp | |||
|
|
|||
| At any one time, only one Interaction can be "driving" the action (that is, it gets to determine the action's current [`phase`](../api/UnityEngine.InputSystem.InputAction.html#UnityEngine_InputSystem_InputAction_phase)). If an Interaction higher up in the stack cancels, Interactions lower down in the stack can take over. | |||
|
|
|||
| Note that the order of interactions can effect which interaction is passed to your callback function. For example, an action with [Tap](#tap), [MultiTap](#multitap) and [Hold](#hold) interactions will have different behaviour when the interactions are in a different order, such as [Hold](#hold), [MultiTap](#multitap) and [Tap](#tap). If you get unexpected behaviour, you may need to experiment with a different ordering. | |||
There was a problem hiding this comment.
Typo: effect should be affect
Also, can we be more specific about when the order will definitely affect which interaction is passed? Can we give an example so that users understand how what to do rather than having to experiment till it works?
There was a problem hiding this comment.
Typo fixed. The example given in the documentation is only one I know of. Right now I couldn't say for sure which orders of interactions would cause unexpected behaviour.
smnwttbr
changed the title
smnwttbr
changed the title
Description
Behaviour can be unexpected when actions use a different ordering of actions. Updated docs to warn the user of this. ISXB-221
Changes made
Paragraph added to docs.
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.