Skip to content

Commit 332e90b

Browse files
committed
Fixed xmldoc referencing internal types.
1 parent 7b1a080 commit 332e90b

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

Packages/com.unity.inputsystem/InputSystem/Actions/InputActionRebindingExtensions.cs

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2084,14 +2084,13 @@ public RebindingOperation OnMatchWaitForAnother(float seconds)
20842084
}
20852085

20862086
/// <summary>
2087-
/// Ensures state changes are allowed to propagate during rebinding but suppresses action updates.
2088-
/// The default behavior is that state changes are also suppressed during rebinding.
2087+
/// Ensures state changes are allowed to propagate during rebinding but suppresses action updates
2088+
/// to prevent u nexpected actions triggering as soon as rebinding ends (event suppression stops).
20892089
/// </summary>
20902090
/// <remarks>
2091-
/// This is achieved by temporarily setting <see cref="InputSystem.inputEventHandledPolicy"/> to
2092-
/// <see cref="InputEventHandledPolicy.SuppressActionUpdates" />. This is automatically reverted when
2093-
/// the rebinding operation completes. If the policy is already set to
2094-
/// <see cref="InputEventHandledPolicy.SuppressActionUpdates" />, this method has no effect.
2091+
/// If events are suppressed during rebinding without suppressing action propagation, it may lead to
2092+
/// unexpected actions triggering as soon as event suppression stops due to missed state transitions.
2093+
/// Action propagation resumes to normal as soon as rebinding operation completes or cancels.
20952094
/// </remarks>
20962095
/// <returns>Reference to this rebinding operation.</returns>
20972096
public RebindingOperation WithSuppressedActionPropagation()

0 commit comments

Comments
 (0)