Merge pull request #25104 from bdach/make-realm-key-binding-action-su…

…ck-less

Refactor key binding panel for easier usage

osu.Game.Tests/Input/RealmKeyBindingTest.cs

@@ -0,0 +1,48 @@
+// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using System;
+using NUnit.Framework;
+using osu.Framework.Allocation;
+using osu.Framework.Input.Bindings;
+using osu.Framework.Testing;
+using osu.Game.Input.Bindings;
+using osu.Game.Rulesets;
+using osu.Game.Rulesets.Catch;
+using osu.Game.Rulesets.Mania;
+using osu.Game.Rulesets.Osu;
+using osu.Game.Rulesets.Taiko;
+using osu.Game.Tests.Visual;
+using osuTK.Input;
+
+namespace osu.Game.Tests.Input
+{
+    [HeadlessTest]
+    public partial class RealmKeyBindingTest : OsuTestScene
+    {
+        [Resolved]
+        private RulesetStore rulesets { get; set; } = null!;
+
+        [Test]
+        public void TestUnmapGlobalAction()
+        {
+            var keyBinding = new RealmKeyBinding(GlobalAction.ToggleReplaySettings, KeyCombination.FromKey(Key.Z));
+
+            AddAssert("action is integer", () => keyBinding.Action, () => Is.EqualTo((int)GlobalAction.ToggleReplaySettings));
+            AddAssert("action unmaps correctly", () => keyBinding.GetAction(rulesets), () => Is.EqualTo(GlobalAction.ToggleReplaySettings));
+        }
+
+        [TestCase(typeof(OsuRuleset), OsuAction.Smoke, null)]
+        [TestCase(typeof(TaikoRuleset), TaikoAction.LeftCentre, null)]
+        [TestCase(typeof(CatchRuleset), CatchAction.MoveRight, null)]
+        [TestCase(typeof(ManiaRuleset), ManiaAction.Key7, 7)]
+        public void TestUnmapRulesetActions(Type rulesetType, object action, int? variant)
+        {
+            string rulesetName = ((Ruleset)Activator.CreateInstance(rulesetType)!).ShortName;
+            var keyBinding = new RealmKeyBinding(action, KeyCombination.FromKey(Key.Z), rulesetName, variant);
+
+            AddAssert("action is integer", () => keyBinding.Action, () => Is.EqualTo((int)action));
+            AddAssert("action unmaps correctly", () => keyBinding.GetAction(rulesets), () => Is.EqualTo(action));
+        }
+    }
+}

osu.Game/Input/Bindings/GlobalActionContainer.cs

@@ -1,6 +1,7 @@
 // Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using osu.Framework.Input;
@@ -13,6 +14,8 @@ namespace osu.Game.Input.Bindings
 {
     public partial class GlobalActionContainer : DatabasedKeyBindingContainer<GlobalAction>, IHandleGlobalKeyboardInput, IKeyBindingHandler<GlobalAction>
     {
+        protected override bool Prioritised => true;
+
         private readonly IKeyBindingHandler<GlobalAction>? handler;
 
         public GlobalActionContainer(OsuGameBase? game)
@@ -22,22 +25,62 @@ public GlobalActionContainer(OsuGameBase? game)
                 handler = h;
         }
 
-        protected override bool Prioritised => true;
-
-        // IMPORTANT: Take care when changing order of the items in the enumerable.
-        // It is used to decide the order of precedence, with the earlier items having higher precedence.
-        public override IEnumerable<IKeyBinding> DefaultKeyBindings => GlobalKeyBindings
-                                                                       .Concat(EditorKeyBindings)
-                                                                       .Concat(InGameKeyBindings)
-                                                                       .Concat(ReplayKeyBindings)
-                                                                       .Concat(SongSelectKeyBindings)
-                                                                       .Concat(AudioControlKeyBindings)
+        /// <summary>
+        /// All default key bindings across all categories, ordered with highest priority first.
+        /// </summary>
+        /// <remarks>
+        /// IMPORTANT: Take care when changing order of the items in the enumerable.
+        /// It is used to decide the order of precedence, with the earlier items having higher precedence.
+        /// </remarks>
+        public override IEnumerable<IKeyBinding> DefaultKeyBindings => globalKeyBindings
+                                                                       .Concat(editorKeyBindings)
+                                                                       .Concat(inGameKeyBindings)
+                                                                       .Concat(replayKeyBindings)
+                                                                       .Concat(songSelectKeyBindings)
+                                                                       .Concat(audioControlKeyBindings)
                                                                        // Overlay bindings may conflict with more local cases like the editor so they are checked last.
                                                                        // It has generally been agreed on that local screens like the editor should have priority,
                                                                        // based on such usages potentially requiring a lot more key bindings that may be "shared" with global ones.
-                                                                       .Concat(OverlayKeyBindings);
+                                                                       .Concat(overlayKeyBindings);
+
+        public static IEnumerable<KeyBinding> GetDefaultBindingsFor(GlobalActionCategory category)
+        {
+            switch (category)
+            {
+                case GlobalActionCategory.General:
+                    return globalKeyBindings;
+
+                case GlobalActionCategory.Editor:
+                    return editorKeyBindings;
+
+                case GlobalActionCategory.InGame:
+                    return inGameKeyBindings;
+
+                case GlobalActionCategory.Replay:
+                    return replayKeyBindings;
+
+                case GlobalActionCategory.SongSelect:
+                    return songSelectKeyBindings;
+
+                case GlobalActionCategory.AudioControl:
+                    return audioControlKeyBindings;
+
+                case GlobalActionCategory.Overlays:
+                    return overlayKeyBindings;
+
+                default:
+                    throw new ArgumentOutOfRangeException(nameof(category), category, $"Unexpected {nameof(GlobalActionCategory)}");
+            }
+        }
+
+        public static IEnumerable<GlobalAction> GetGlobalActionsFor(GlobalActionCategory category)
+            => GetDefaultBindingsFor(category).Select(binding => binding.Action).Cast<GlobalAction>().Distinct();
+
+        public bool OnPressed(KeyBindingPressEvent<GlobalAction> e) => handler?.OnPressed(e) == true;
 
-        public IEnumerable<KeyBinding> GlobalKeyBindings => new[]
+        public void OnReleased(KeyBindingReleaseEvent<GlobalAction> e) => handler?.OnReleased(e);
+
+        private static IEnumerable<KeyBinding> globalKeyBindings => new[]
         {
             new KeyBinding(InputKey.Up, GlobalAction.SelectPrevious),
             new KeyBinding(InputKey.Down, GlobalAction.SelectNext),
@@ -67,7 +110,7 @@ public GlobalActionContainer(OsuGameBase? game)
             new KeyBinding(InputKey.F12, GlobalAction.TakeScreenshot),
         };
 
-        public IEnumerable<KeyBinding> OverlayKeyBindings => new[]
+        private static IEnumerable<KeyBinding> overlayKeyBindings => new[]
         {
             new KeyBinding(InputKey.F8, GlobalAction.ToggleChat),
             new KeyBinding(InputKey.F6, GlobalAction.ToggleNowPlaying),
@@ -77,7 +120,7 @@ public GlobalActionContainer(OsuGameBase? game)
             new KeyBinding(new[] { InputKey.Control, InputKey.N }, GlobalAction.ToggleNotifications),
         };
 
-        public IEnumerable<KeyBinding> EditorKeyBindings => new[]
+        private static IEnumerable<KeyBinding> editorKeyBindings => new[]
         {
             new KeyBinding(new[] { InputKey.F1 }, GlobalAction.EditorComposeMode),
             new KeyBinding(new[] { InputKey.F2 }, GlobalAction.EditorDesignMode),
@@ -101,7 +144,7 @@ public GlobalActionContainer(OsuGameBase? game)
             new KeyBinding(new[] { InputKey.Control, InputKey.R }, GlobalAction.EditorToggleRotateControl),
         };
 
-        public IEnumerable<KeyBinding> InGameKeyBindings => new[]
+        private static IEnumerable<KeyBinding> inGameKeyBindings => new[]
         {
             new KeyBinding(InputKey.Space, GlobalAction.SkipCutscene),
             new KeyBinding(InputKey.ExtraMouseButton2, GlobalAction.SkipCutscene),
@@ -118,7 +161,7 @@ public GlobalActionContainer(OsuGameBase? game)
             new KeyBinding(InputKey.F2, GlobalAction.ExportReplay),
         };
 
-        public IEnumerable<KeyBinding> ReplayKeyBindings => new[]
+        private static IEnumerable<KeyBinding> replayKeyBindings => new[]
         {
             new KeyBinding(InputKey.Space, GlobalAction.TogglePauseReplay),
             new KeyBinding(InputKey.MouseMiddle, GlobalAction.TogglePauseReplay),
@@ -127,7 +170,7 @@ public GlobalActionContainer(OsuGameBase? game)
             new KeyBinding(new[] { InputKey.Control, InputKey.H }, GlobalAction.ToggleReplaySettings),
         };
 
-        public IEnumerable<KeyBinding> SongSelectKeyBindings => new[]
+        private static IEnumerable<KeyBinding> songSelectKeyBindings => new[]
         {
             new KeyBinding(InputKey.F1, GlobalAction.ToggleModSelection),
             new KeyBinding(InputKey.F2, GlobalAction.SelectNextRandom),
@@ -136,7 +179,7 @@ public GlobalActionContainer(OsuGameBase? game)
             new KeyBinding(InputKey.BackSpace, GlobalAction.DeselectAllMods),
         };
 
-        public IEnumerable<KeyBinding> AudioControlKeyBindings => new[]
+        private static IEnumerable<KeyBinding> audioControlKeyBindings => new[]
         {
             new KeyBinding(new[] { InputKey.Alt, InputKey.Up }, GlobalAction.IncreaseVolume),
             new KeyBinding(new[] { InputKey.Alt, InputKey.Down }, GlobalAction.DecreaseVolume),
@@ -153,10 +196,6 @@ public GlobalActionContainer(OsuGameBase? game)
             new KeyBinding(InputKey.PlayPause, GlobalAction.MusicPlay),
             new KeyBinding(InputKey.F3, GlobalAction.MusicPlay)
         };
-
-        public bool OnPressed(KeyBindingPressEvent<GlobalAction> e) => handler?.OnPressed(e) == true;
-
-        public void OnReleased(KeyBindingReleaseEvent<GlobalAction> e) => handler?.OnReleased(e);
     }
 
     public enum GlobalAction
@@ -365,4 +404,15 @@ public enum GlobalAction
         [LocalisableDescription(typeof(GlobalActionKeyBindingStrings), nameof(GlobalActionKeyBindingStrings.EditorToggleRotateControl))]
         EditorToggleRotateControl,
     }
+
+    public enum GlobalActionCategory
+    {
+        General,
+        Editor,
+        InGame,
+        Replay,
+        SongSelect,
+        AudioControl,
+        Overlays
+    }
 }

osu.Game/Input/Bindings/RealmKeyBinding.cs

@@ -2,9 +2,11 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using System;
+using System.Linq;
 using JetBrains.Annotations;
 using osu.Framework.Input.Bindings;
 using osu.Game.Database;
+using osu.Game.Rulesets;
 using Realms;
 
 namespace osu.Game.Input.Bindings
@@ -26,6 +28,13 @@ public KeyCombination KeyCombination
             set => KeyCombinationString = value.ToString();
         }
 
+        /// <summary>
+        /// The resultant action which is triggered by this binding.
+        /// </summary>
+        /// <remarks>
+        /// This implementation always returns an integer.
+        /// If wanting to get the actual enum-typed value, use <see cref="GetAction"/>.
+        /// </remarks>
         [Ignored]
         public object Action
         {
@@ -53,5 +62,20 @@ public RealmKeyBinding(object action, KeyCombination keyCombination, string? rul
         private RealmKeyBinding()
         {
         }
+
+        public object GetAction(RulesetStore rulesets)
+        {
+            if (string.IsNullOrEmpty(RulesetName))
+                return (GlobalAction)ActionInt;
+
+            var ruleset = rulesets.GetRuleset(RulesetName);
+            var actionType = ruleset!.CreateInstance()
+                                     .GetDefaultKeyBindings(Variant ?? 0)
+                                     .First() // let's just assume nobody does something stupid like mix multiple types...
+                                     .Action
+                                     .GetType();
+
+            return Enum.ToObject(actionType, ActionInt);
+        }
     }
 }

osu.Game/Overlays/Settings/Sections/Input/GlobalKeyBindingsSection.cs

@@ -1,6 +1,7 @@
 // Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
+using osu.Framework.Allocation;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Sprites;
 using osu.Framework.Localisation;
@@ -18,92 +19,19 @@ public partial class GlobalKeyBindingsSection : SettingsSection
 
         public override LocalisableString Header => InputSettingsStrings.GlobalKeyBindingHeader;
 
-        public GlobalKeyBindingsSection(GlobalActionContainer manager)
+        [BackgroundDependencyLoader]
+        private void load()
         {
-            Add(new DefaultBindingsSubsection(manager));
-            Add(new OverlayBindingsSubsection(manager));
-            Add(new AudioControlKeyBindingsSubsection(manager));
-            Add(new SongSelectKeyBindingSubsection(manager));
-            Add(new InGameKeyBindingsSubsection(manager));
-            Add(new ReplayKeyBindingsSubsection(manager));
-            Add(new EditorKeyBindingsSubsection(manager));
-        }
-
-        private partial class DefaultBindingsSubsection : KeyBindingsSubsection
-        {
-            protected override LocalisableString Header => string.Empty;
-
-            public DefaultBindingsSubsection(GlobalActionContainer manager)
-                : base(null)
-            {
-                Defaults = manager.GlobalKeyBindings;
-            }
-        }
-
-        private partial class OverlayBindingsSubsection : KeyBindingsSubsection
-        {
-            protected override LocalisableString Header => InputSettingsStrings.OverlaysSection;
-
-            public OverlayBindingsSubsection(GlobalActionContainer manager)
-                : base(null)
-            {
-                Defaults = manager.OverlayKeyBindings;
-            }
-        }
-
-        private partial class SongSelectKeyBindingSubsection : KeyBindingsSubsection
-        {
-            protected override LocalisableString Header => InputSettingsStrings.SongSelectSection;
-
-            public SongSelectKeyBindingSubsection(GlobalActionContainer manager)
-                : base(null)
-            {
-                Defaults = manager.SongSelectKeyBindings;
-            }
-        }
-
-        private partial class InGameKeyBindingsSubsection : KeyBindingsSubsection
-        {
-            protected override LocalisableString Header => InputSettingsStrings.InGameSection;
-
-            public InGameKeyBindingsSubsection(GlobalActionContainer manager)
-                : base(null)
-            {
-                Defaults = manager.InGameKeyBindings;
-            }
-        }
-
-        private partial class ReplayKeyBindingsSubsection : KeyBindingsSubsection
-        {
-            protected override LocalisableString Header => InputSettingsStrings.ReplaySection;
-
-            public ReplayKeyBindingsSubsection(GlobalActionContainer manager)
-                : base(null)
-            {
-                Defaults = manager.ReplayKeyBindings;
-            }
-        }
-
-        private partial class AudioControlKeyBindingsSubsection : KeyBindingsSubsection
-        {
-            protected override LocalisableString Header => InputSettingsStrings.AudioSection;
-
-            public AudioControlKeyBindingsSubsection(GlobalActionContainer manager)
-                : base(null)
-            {
-                Defaults = manager.AudioControlKeyBindings;
-            }
-        }
-
-        private partial class EditorKeyBindingsSubsection : KeyBindingsSubsection
-        {
-            protected override LocalisableString Header => InputSettingsStrings.EditorSection;
-
-            public EditorKeyBindingsSubsection(GlobalActionContainer manager)
-                : base(null)
+            AddRange(new[]
             {
-                Defaults = manager.EditorKeyBindings;
-            }
+                new GlobalKeyBindingsSubsection(string.Empty, GlobalActionCategory.General),
+                new GlobalKeyBindingsSubsection(InputSettingsStrings.OverlaysSection, GlobalActionCategory.Overlays),
+                new GlobalKeyBindingsSubsection(InputSettingsStrings.AudioSection, GlobalActionCategory.AudioControl),
+                new GlobalKeyBindingsSubsection(InputSettingsStrings.SongSelectSection, GlobalActionCategory.SongSelect),
+                new GlobalKeyBindingsSubsection(InputSettingsStrings.InGameSection, GlobalActionCategory.InGame),
+                new GlobalKeyBindingsSubsection(InputSettingsStrings.ReplaySection, GlobalActionCategory.Replay),
+                new GlobalKeyBindingsSubsection(InputSettingsStrings.EditorSection, GlobalActionCategory.Editor),
+            });
         }
     }
 }