FIX: UI inconsistencies - Single helpbox for repetitive default settings mentions (#2372)

Author: josepmariapujol-unity

Packages/com.unity.inputsystem/CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Fixed
 
+- Simplified default setting messaging by consolidating repetitive messages into a single HelpBox.
 - Fixed a `NullPointerReferenceException` thrown in `InputManagerStateMonitors.FireStateChangeNotifications` logging by adding validation [UUM-136095].
 - Fixed auto-save not working for Input System actions in Project Settings when both the Project Settings and Input System Actions windows were open [UUM-134035](https://jira.unity3d.com/browse/UUM-134035)
 - Improved New Input System warning dialog, Native Device Inputs Not Enabled [UUM-132151].

Packages/com.unity.inputsystem/InputSystem/Actions/Interactions/HoldInteraction.cs

@@ -135,6 +135,8 @@ public override void OnDrawVisualElements(VisualElement root, Action onChangedCa
         {
             m_DurationSetting.OnDrawVisualElements(root, onChangedCallback);
             m_PressPointSetting.OnDrawVisualElements(root, onChangedCallback);
+            CustomOrDefaultSetting.AddSharedDefaultSettingsFooter(root,
+                new[] { m_PressPointSetting, m_DurationSetting });
         }
 
         private CustomOrDefaultSetting m_DurationSetting;

Packages/com.unity.inputsystem/InputSystem/Actions/Interactions/MultiTapInteraction.cs

@@ -222,6 +222,8 @@ public override void OnDrawVisualElements(VisualElement root, Action onChangedCa
             m_TapDelaySetting.OnDrawVisualElements(root, onChangedCallback);
             m_TapTimeSetting.OnDrawVisualElements(root, onChangedCallback);
             m_PressPointSetting.OnDrawVisualElements(root, onChangedCallback);
+            CustomOrDefaultSetting.AddSharedDefaultSettingsFooter(root,
+                new[] { m_TapTimeSetting, m_TapDelaySetting, m_PressPointSetting });
         }
 
         private readonly GUIContent m_TapCountLabel = new GUIContent("Tap Count", "How many taps need to be performed in succession. Two means double-tap, three means triple-tap, and so on.");

Packages/com.unity.inputsystem/InputSystem/Actions/Interactions/PressInteraction.cs

@@ -237,6 +237,8 @@ public override void OnDrawVisualElements(VisualElement root, Action onChangedCa
             root.Add(behaviourDropdown);
 
             m_PressPointSetting.OnDrawVisualElements(root, onChangedCallback);
+            CustomOrDefaultSetting.AddSharedDefaultSettingsFooter(root,
+                new[] { m_PressPointSetting });
         }
 
         private CustomOrDefaultSetting m_PressPointSetting;

Packages/com.unity.inputsystem/InputSystem/Actions/Interactions/SlowTapInteraction.cs

@@ -99,6 +99,8 @@ public override void OnDrawVisualElements(VisualElement root, Action onChangedCa
         {
             m_DurationSetting.OnDrawVisualElements(root, onChangedCallback);
             m_PressPointSetting.OnDrawVisualElements(root, onChangedCallback);
+            CustomOrDefaultSetting.AddSharedDefaultSettingsFooter(root,
+                new[] { m_DurationSetting, m_PressPointSetting });
         }
 
         private CustomOrDefaultSetting m_DurationSetting;

Packages/com.unity.inputsystem/InputSystem/Actions/Interactions/TapInteraction.cs

@@ -125,6 +125,8 @@ public override void OnDrawVisualElements(VisualElement root, Action onChangedCa
         {
             m_DurationSetting.OnDrawVisualElements(root, onChangedCallback);
             m_PressPointSetting.OnDrawVisualElements(root, onChangedCallback);
+            CustomOrDefaultSetting.AddSharedDefaultSettingsFooter(root,
+                new[] { m_DurationSetting, m_PressPointSetting });
         }
 
         private CustomOrDefaultSetting m_DurationSetting;

Packages/com.unity.inputsystem/InputSystem/Controls/Processors/AxisDeadzoneProcessor.cs

@@ -104,6 +104,8 @@ public override void OnDrawVisualElements(VisualElement root, Action onChangedCa
         {
             m_MinSetting.OnDrawVisualElements(root, onChangedCallback);
             m_MaxSetting.OnDrawVisualElements(root, onChangedCallback);
+            CustomOrDefaultSetting.AddSharedDefaultSettingsFooter(root,
+                new[] { m_MinSetting, m_MaxSetting });
         }
 
         private CustomOrDefaultSetting m_MinSetting;

Packages/com.unity.inputsystem/InputSystem/Controls/Processors/StickDeadzoneProcessor.cs

@@ -93,6 +93,8 @@ public override void OnDrawVisualElements(VisualElement root, Action onChangedCa
         {
             m_MinSetting.OnDrawVisualElements(root, onChangedCallback);
             m_MaxSetting.OnDrawVisualElements(root, onChangedCallback);
+            CustomOrDefaultSetting.AddSharedDefaultSettingsFooter(root,
+                new[] { m_MinSetting, m_MaxSetting });
         }
 
         private CustomOrDefaultSetting m_MinSetting;

Packages/com.unity.inputsystem/InputSystem/Editor/InputParameterEditor.cs

@@ -215,14 +215,65 @@ public void Initialize(string label, string tooltip, string defaultName, Func<fl
                     ? $"If enabled, the default {label.ToLowerInvariant()} configured globally in the input settings is used. See Edit >> Project Settings... >> Input (NEW)."
                     : "If enabled, the default value is used.");
                 m_ValueLabel = EditorGUIUtility.TrTextContent(label, tooltip);
-                if (defaultComesFromInputSettings)
-                    m_OpenInputSettingsLabel = EditorGUIUtility.TrTextContent("Open Input Settings");
                 m_DefaultInitializedValue = defaultInitializedValue;
                 m_UseDefaultValue = Mathf.Approximately(getValue(), defaultInitializedValue);
                 m_DefaultComesFromInputSettings = defaultComesFromInputSettings;
-                m_HelpBoxText =
-                    EditorGUIUtility.TrTextContent(
-                        $"Uses \"{defaultName}\" set in project-wide input settings.");
+                m_DefaultName = defaultName;
+            }
+
+            /// <summary>
+            /// Raised when the "use default" toggle changes. Allows multiple subscribers to react
+            /// (e.g. refreshing shared footers) without overwriting each other.
+            /// </summary>
+            internal event Action onUseDefaultChanged;
+
+            internal static void AddSharedDefaultSettingsFooter(VisualElement root,
+                IReadOnlyList<CustomOrDefaultSetting> settings)
+            {
+                if (settings == null || settings.Count == 0)
+                    return;
+
+                var footerContainer = new VisualElement();
+                var helpBox = new HelpBox("", HelpBoxMessageType.None);
+                var buttonContainer = new VisualElement { style = { flexDirection = FlexDirection.RowReverse } };
+                var openInputSettingsButton = new Button(InputSettingsProvider.Open)
+                {
+                    text = EditorGUIUtility.TrTextContent("Open Input Settings").text
+                };
+                openInputSettingsButton.AddToClassList("open-settings-button");
+                buttonContainer.Add(openInputSettingsButton);
+                footerContainer.Add(helpBox);
+                footerContainer.Add(buttonContainer);
+
+                void RefreshFooter()
+                {
+                    var namesInUse = new List<string>(settings.Count);
+                    foreach (var s in settings)
+                    {
+                        if (s.m_UseDefaultValue && s.m_DefaultComesFromInputSettings)
+                            namesInUse.Add(s.m_DefaultName);
+                    }
+                    if (namesInUse.Count > 0)
+                    {
+                        var quotedNames = new List<string>(namesInUse.Count);
+                        foreach (var n in namesInUse)
+                            quotedNames.Add($"\"{n}\"");
+                        var combinedNames = string.Join(", ", quotedNames);
+                        helpBox.text = EditorGUIUtility.TrTextContent(
+                            $"Uses {combinedNames} set in Input System Package Settings.").text;
+                        footerContainer.style.display = DisplayStyle.Flex;
+                    }
+                    else
+                    {
+                        footerContainer.style.display = DisplayStyle.None;
+                    }
+                }
+
+                foreach (var s in settings)
+                    s.onUseDefaultChanged += RefreshFooter;
+
+                RefreshFooter();
+                root.Add(footerContainer);
             }
 
             public void OnDrawVisualElements(VisualElement root, Action onChangedCallback)
@@ -250,8 +301,6 @@ public void OnDrawVisualElements(VisualElement root, Action onChangedCallback)
                 m_FloatField.RegisterCallback<BlurEvent>(_ => OnEditEnd(onChangedCallback));
                 m_FloatField.SetEnabled(!m_UseDefaultValue);
 
-                m_HelpBox = new HelpBox(m_HelpBoxText.text, HelpBoxMessageType.None);
-
                 m_DefaultToggle = new Toggle("Default")
                 {
                     value = m_UseDefaultValue,
@@ -263,28 +312,9 @@ public void OnDrawVisualElements(VisualElement root, Action onChangedCallback)
                 m_DefaultToggle.RegisterValueChangedCallback(evt => ToggleUseDefaultValue(evt, onChangedCallback));
                 m_DefaultToggle.Q<Label>().style.minWidth = new StyleLength(StyleKeyword.Auto);
 
-                var buttonContainer = new VisualElement
-                {
-                    style =
-                    {
-                        flexDirection = FlexDirection.RowReverse
-                    }
-                };
-                m_OpenInputSettingsButton = new Button(InputSettingsProvider.Open){text = m_OpenInputSettingsLabel.text};
-                m_OpenInputSettingsButton.AddToClassList("open-settings-button");
-
                 settingsContainer.Add(m_FloatField);
                 settingsContainer.Add(m_DefaultToggle);
                 container.Add(settingsContainer);
-
-                if (m_UseDefaultValue)
-                {
-                    buttonContainer.Add(m_OpenInputSettingsButton);
-                    container.Add(m_HelpBox);
-                }
-
-                container.Add(buttonContainer);
-
                 root.Add(container);
             }
 
@@ -314,7 +344,7 @@ private void ChangeSettingValue(ChangeEvent<float> evt)
 
             private void OnEditEnd(Action onChangedCallback)
             {
-                onChangedCallback.Invoke();
+                onChangedCallback?.Invoke();
             }
 
             private void ToggleUseDefaultValue(ChangeEvent<bool> evt, Action onChangedCallback)
@@ -327,6 +357,7 @@ private void ToggleUseDefaultValue(ChangeEvent<bool> evt, Action onChangedCallba
 
                 m_UseDefaultValue = evt.newValue;
                 m_FloatField?.SetEnabled(!m_UseDefaultValue);
+                onUseDefaultChanged?.Invoke();
             }
 
             private void SetValue(float newValue)
@@ -361,15 +392,15 @@ public void OnGUI()
                 if ((value - float.Epsilon) == m_DefaultInitializedValue)
                     value = m_DefaultInitializedValue;
 
-                ////TODO: use slider rather than float field
                 var newValue = EditorGUILayout.FloatField(m_ValueLabel, value, GUILayout.ExpandWidth(false));
                 if (!m_UseDefaultValue)
                     SetValue(newValue);
 
                 EditorGUI.EndDisabledGroup();
 
                 var newUseDefault = GUILayout.Toggle(m_UseDefaultValue, m_ToggleLabel, GUILayout.ExpandWidth(false));
-                if (newUseDefault != m_UseDefaultValue)
+                var useDefaultChanged = newUseDefault != m_UseDefaultValue;
+                if (useDefaultChanged)
                 {
                     if (!newUseDefault)
                         m_SetValue(m_GetDefaultValue());
@@ -378,19 +409,9 @@ public void OnGUI()
                 }
 
                 m_UseDefaultValue = newUseDefault;
+                if (useDefaultChanged)
+                    onUseDefaultChanged?.Invoke();
                 EditorGUILayout.EndHorizontal();
-
-                // If we're using a default from global InputSettings, show info text for that and provide
-                // button to open input settings.
-                if (m_UseDefaultValue && m_DefaultComesFromInputSettings)
-                {
-                    EditorGUILayout.HelpBox(m_HelpBoxText);
-                    EditorGUILayout.BeginHorizontal();
-                    GUILayout.FlexibleSpace();
-                    if (GUILayout.Button(m_OpenInputSettingsLabel, EditorStyles.miniButton))
-                        InputSettingsProvider.Open();
-                    EditorGUILayout.EndHorizontal();
-                }
             }
 
             private Func<float> m_GetValue;
@@ -399,14 +420,11 @@ public void OnGUI()
             private bool m_UseDefaultValue;
             private bool m_DefaultComesFromInputSettings;
             private float m_DefaultInitializedValue;
+            private string m_DefaultName;
             private GUIContent m_ToggleLabel;
             private GUIContent m_ValueLabel;
-            private GUIContent m_OpenInputSettingsLabel;
-            private GUIContent m_HelpBoxText;
             private FloatField m_FloatField;
-            private Button m_OpenInputSettingsButton;
             private Toggle m_DefaultToggle;
-            private HelpBox m_HelpBox;
         }
     }
 }