Added support for suppressing any kind of state event during rebinding when the rebinding screen has no UI. Added missing exception checks for attempting to reconfigure rebinding during rebinding.

Author: ekcoh

Assets/Samples/RebindingUI/RebindActionUI.cs

@@ -90,6 +90,17 @@ public Text rebindPrompt
             set => m_RebindText = value;
         }
 
+        /// <summary>
+        /// Optional text component that shows relevant information when waiting for a control to be actuated.
+        /// </summary>
+        /// <seealso cref="rebindPrompt"/>
+        /// <seealso cref="rebindOverlay"/>
+        public Text rebindInfo
+        {
+            get => m_RebindInfo;
+            set => m_RebindInfo = value;
+        }
+
         /// <summary>
         /// Optional UI that is activated when an interactive rebind is started and deactivated when the rebind
         /// is finished. This is normally used to display an overlay over the current UI while the system is
@@ -293,7 +304,13 @@ void CleanUp()
                         UpdateBindingDisplay();
                         CleanUp();
                     })
-                .WithSuppressedActionPropagation()
+                // We want matching events to be suppressed during rebinding (this is also default).
+                .WithMatchingEventsBeingSuppressed()
+                // Since this sample has no interactable UI during rebinding we also want to suppress non-matching events.
+                .WithNonMatchingEventsBeingSuppressed()
+                // We want device state to update but not actions firing during rebinding.
+                .WithActionsBeingSuppressed()
+                // Since this sample has no UI to cancle rebinding we timeout after not receiving input for a period of time.
                 .WithTimeout(10.0f)
                 .OnComplete(
                     operation =>
@@ -329,6 +346,13 @@ void CleanUp()
                 m_RebindText.text = text;
             }
 
+            // Update rebind overlay information, if we have one.
+            if (m_RebindInfo != null)
+            {
+                m_RebindStartTime = Time.realtimeSinceStartup;
+                UpdateRebindInfo(m_RebindStartTime);
+            }
+
             // If we have no rebind overlay and no callback but we have a binding text label,
             // temporarily set the binding text label to "<Waiting>".
             if (m_RebindOverlay == null && m_RebindText == null && m_RebindStartEvent == null && m_BindingText != null)
@@ -340,6 +364,29 @@ void CleanUp()
             m_RebindOperation.Start();
         }
 
+        private void UpdateRebindInfo(double now)
+        {
+            if (m_RebindOperation == null)
+                return;
+
+            var elapsed = now - m_RebindStartTime;
+            var remainingTimeoutWholeSeconds = (int)Math.Floor(m_RebindOperation.timeout - elapsed);
+            if (remainingTimeoutWholeSeconds == m_LastRemainingTimeoutSeconds)
+                return;
+
+            var text = (m_RebindOperation.timeout > 0.0f)
+                ? $"(This will timeout in <b>{remainingTimeoutWholeSeconds}</b> seconds if no matching input is received)"
+                : string.Empty;
+            m_RebindInfo.text = text;
+            m_LastRemainingTimeoutSeconds = remainingTimeoutWholeSeconds;
+        }
+
+        protected void Update()
+        {
+            if (m_RebindInfo != null)
+                UpdateRebindInfo(Time.realtimeSinceStartupAsDouble);
+        }
+
         protected void OnEnable()
         {
             if (s_RebindActionUIs == null)
@@ -416,6 +463,10 @@ private static void OnActionChange(object obj, InputActionChange change)
         [SerializeField]
         private Text m_RebindText;
 
+        [Tooltip("Optional text label that will be updated with relevant information during rebinding.")]
+        [SerializeField]
+        private Text m_RebindInfo;
+
         [Tooltip("Event that is triggered when the way the binding is display should be updated. This allows displaying "
             + "bindings in custom ways, e.g. using images instead of text.")]
         [SerializeField]
@@ -435,6 +486,9 @@ private static void OnActionChange(object obj, InputActionChange change)
 
         private static List<RebindActionUI> s_RebindActionUIs;
 
+        private double m_RebindStartTime = -1;
+        private int m_LastRemainingTimeoutSeconds;
+
         // We want the label for the action name to update in edit mode, too, so
         // we kick that off from here.
         #if UNITY_EDITOR

Assets/Samples/RebindingUI/RebindActionUIEditor.cs

@@ -21,6 +21,7 @@ protected void OnEnable()
             m_BindingTextProperty = serializedObject.FindProperty("m_BindingText");
             m_RebindOverlayProperty = serializedObject.FindProperty("m_RebindOverlay");
             m_RebindTextProperty = serializedObject.FindProperty("m_RebindText");
+            m_RebindInfoProperty = serializedObject.FindProperty("m_RebindInfo");
             m_UpdateBindingUIEventProperty = serializedObject.FindProperty("m_UpdateBindingUIEvent");
             m_RebindStartEventProperty = serializedObject.FindProperty("m_RebindStartEvent");
             m_RebindStopEventProperty = serializedObject.FindProperty("m_RebindStopEvent");
@@ -62,6 +63,7 @@ public override void OnInspectorGUI()
                 EditorGUILayout.PropertyField(m_BindingTextProperty);
                 EditorGUILayout.PropertyField(m_RebindOverlayProperty);
                 EditorGUILayout.PropertyField(m_RebindTextProperty);
+                EditorGUILayout.PropertyField(m_RebindInfoProperty);
             }
 
             // Events section.
@@ -155,6 +157,7 @@ protected void RefreshBindingOptions()
         private SerializedProperty m_BindingTextProperty;
         private SerializedProperty m_RebindOverlayProperty;
         private SerializedProperty m_RebindTextProperty;
+        private SerializedProperty m_RebindInfoProperty;
         private SerializedProperty m_RebindStartEventProperty;
         private SerializedProperty m_RebindStopEventProperty;
         private SerializedProperty m_UpdateBindingUIEventProperty;

Assets/Samples/RebindingUI/RebindingMaterial.mat

@@ -79,7 +79,7 @@ Material:
     - _UVSec: 0
     - _ZWrite: 1
     m_Colors:
-    - _Color: {r: 0.99999994, g: 1e-45, b: 1e-45, a: 1}
+    - _Color: {r: 1, g: 0, b: 0, a: 1}
     - _EmissionColor: {r: 0.27450982, g: 0.078431375, b: 0.19607843, a: 1}
   m_BuildTextureStacks: []
   m_AllowLocking: 1