Updated rebinding UI sample to use new feature (handling policy)

Author: ekcoh

Assets/ActionDebug.cs

@@ -1,5 +1,6 @@
 using UnityEngine;
 using UnityEngine.InputSystem;
+using UnityEngine.InputSystem.LowLevel;
 
 public class ActionDebug : MonoBehaviour
 {
@@ -8,17 +9,31 @@ public class ActionDebug : MonoBehaviour
     // Start is called once before the first execution of Update after the MonoBehaviour is created
     void Start()
     {
-        trigger.action.performed += ActionOnperformed;
+        trigger.action.performed += ActionOnPerformed;
+        trigger.action.canceled += ActionOnCanceled;
+        trigger.action.started += ActionOnStarted;
         trigger.action.Enable();
     }
 
-    private void ActionOnperformed(InputAction.CallbackContext obj)
+    private void ActionOnStarted(InputAction.CallbackContext obj)
+    {
+        Debug.Log("Action Started");
+    }
+
+    private void ActionOnCanceled(InputAction.CallbackContext obj)
+    {
+        Debug.Log("Action Canceled");
+    }
+
+    private void ActionOnPerformed(InputAction.CallbackContext obj)
     {
         Debug.Log("Action Performed");
     }
 
     // Update is called once per frame
     void Update()
     {
+        if (trigger.action.WasPerformedThisFrame())
+            Debug.Log("Action Performed (Polled Event)");
     }
 }

Assets/Samples/RebindingUI/RebindActionUI.cs

@@ -289,7 +289,7 @@ void CleanUp()
                         UpdateBindingDisplay();
                         CleanUp();
                     })
-                .OnMatchWaitForAnother(0.2f)
+                .WithSuppressedActionPropagation()
                 .OnComplete(
                     operation =>
                     {

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

@@ -2083,6 +2083,23 @@ public RebindingOperation OnMatchWaitForAnother(float seconds)
                 return this;
             }
 
+            /// <summary>
+            /// Ensures state changes are allowed to propagate during rebinding but suppresses action updates.
+            /// The default behavior is that state changes are also suppressed during rebinding.
+            /// </summary>
+            /// <remarks>
+            /// This is achieved by temporarily setting <see cref="InputSystem.inputEventHandledPolicy"/> to
+            /// <see cref="InputEventHandledPolicy.SuppressActionUpdates" />. This is automatically reverted when
+            /// the rebinding operation completes. If the policy is already set to
+            /// <see cref="InputEventHandledPolicy.SuppressActionUpdates" />, this method has no effect.
+            /// </remarks>
+            /// <returns>Reference to this rebinding operation.</returns>
+            public RebindingOperation WithSuppressedActionPropagation()
+            {
+                m_TargetInputEventHandledPolicy = InputEventHandledPolicy.SuppressActionUpdates;
+                return this;
+            }
+
             /// <summary>
             /// Start the rebinding. This should be invoked after the rebind operation has been fully configured.
             /// </summary>
@@ -2107,6 +2124,9 @@ public RebindingOperation Start()
 
                 m_StartTime = InputState.currentTime;
 
+                m_SavedInputEventHandledPolicy = InputSystem.inputEventHandledPolicy;
+                InputSystem.inputEventHandledPolicy = m_TargetInputEventHandledPolicy;
+
                 if (m_WaitSecondsAfterMatch > 0 || m_Timeout > 0)
                 {
                     HookOnAfterUpdate();
@@ -2606,6 +2626,8 @@ private void ResetAfterMatchCompleted()
 
                 UnhookOnEvent();
                 UnhookOnAfterUpdate();
+
+                InputSystem.inputEventHandledPolicy = m_SavedInputEventHandledPolicy;
             }
 
             private void ThrowIfRebindInProgress()
@@ -2654,6 +2676,8 @@ private string GeneratePathForControl(InputControl control)
             private double m_StartTime;
             private float m_Timeout;
             private float m_WaitSecondsAfterMatch;
+            private InputEventHandledPolicy m_SavedInputEventHandledPolicy;
+            private InputEventHandledPolicy m_TargetInputEventHandledPolicy;
             private InputControlList<InputControl> m_Candidates;
             private Action<RebindingOperation> m_OnComplete;
             private Action<RebindingOperation> m_OnCancel;