Merge pull request #18011 from frenzibyte/rewind-shift-click

Allow rewinding random in song select with "Shift + Left Click"

osu.Game.Tests/Visual/SongSelect/TestSceneSongSelectFooter.cs

@@ -1,35 +1,99 @@
 // Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
+using NUnit.Framework;
 using osu.Framework.Graphics;
 using osu.Game.Screens.Select;
+using osuTK;
+using osuTK.Input;
 
 namespace osu.Game.Tests.Visual.SongSelect
 {
     public class TestSceneSongSelectFooter : OsuManualInputManagerTestScene
     {
-        public TestSceneSongSelectFooter()
+        private FooterButtonRandom randomButton;
+
+        private bool nextRandomCalled;
+        private bool previousRandomCalled;
+
+        [SetUp]
+        public void SetUp() => Schedule(() =>
+        {
+            nextRandomCalled = false;
+            previousRandomCalled = false;
+
+            Footer footer;
+
+            Child = footer = new Footer
+            {
+                Anchor = Anchor.Centre,
+                Origin = Anchor.Centre,
+            };
+
+            footer.AddButton(new FooterButtonMods(), null);
+            footer.AddButton(randomButton = new FooterButtonRandom
+            {
+                NextRandom = () => nextRandomCalled = true,
+                PreviousRandom = () => previousRandomCalled = true,
+            }, null);
+            footer.AddButton(new FooterButtonOptions(), null);
+
+            InputManager.MoveMouseTo(Vector2.Zero);
+        });
+
+        [Test]
+        public void TestFooterRandom()
+        {
+            AddStep("press F2", () => InputManager.Key(Key.F2));
+            AddAssert("next random invoked", () => nextRandomCalled && !previousRandomCalled);
+        }
+
+        [Test]
+        public void TestFooterRandomViaMouse()
+        {
+            AddStep("click button", () =>
+            {
+                InputManager.MoveMouseTo(randomButton);
+                InputManager.Click(MouseButton.Left);
+            });
+            AddAssert("next random invoked", () => nextRandomCalled && !previousRandomCalled);
+        }
+
+        [Test]
+        public void TestFooterRewind()
+        {
+            AddStep("press Shift+F2", () =>
+            {
+                InputManager.PressKey(Key.LShift);
+                InputManager.PressKey(Key.F2);
+                InputManager.ReleaseKey(Key.F2);
+                InputManager.ReleaseKey(Key.LShift);
+            });
+            AddAssert("previous random invoked", () => previousRandomCalled && !nextRandomCalled);
+        }
+
+        [Test]
+        public void TestFooterRewindViaShiftMouseLeft()
+        {
+            AddStep("shift + click button", () =>
+            {
+                InputManager.PressKey(Key.LShift);
+                InputManager.MoveMouseTo(randomButton);
+                InputManager.Click(MouseButton.Left);
+                InputManager.ReleaseKey(Key.LShift);
+            });
+            AddAssert("previous random invoked", () => previousRandomCalled && !nextRandomCalled);
+        }
+
+        [Test]
+        public void TestFooterRewindViaMouseRight()
         {
-            AddStep("Create footer", () =>
+            AddStep("right click button", () =>
             {
-                Footer footer;
-                AddRange(new Drawable[]
-                {
-                    footer = new Footer
-                    {
-                        Anchor = Anchor.Centre,
-                        Origin = Anchor.Centre,
-                    }
-                });
-
-                footer.AddButton(new FooterButtonMods(), null);
-                footer.AddButton(new FooterButtonRandom
-                {
-                    NextRandom = () => { },
-                    PreviousRandom = () => { },
-                }, null);
-                footer.AddButton(new FooterButtonOptions(), null);
+                InputManager.MoveMouseTo(randomButton);
+                InputManager.Click(MouseButton.Right);
             });
+            AddAssert("previous random invoked", () => previousRandomCalled && !nextRandomCalled);
         }
     }
 }

osu.Game/Screens/Select/FooterButtonRandom.cs

@@ -10,6 +10,7 @@
 using osu.Game.Graphics.Sprites;
 using osu.Game.Input.Bindings;
 using osuTK;
+using osuTK.Input;
 
 namespace osu.Game.Screens.Select
 {
@@ -25,7 +26,7 @@ private void load(OsuColour colours)
         {
             SelectedColour = colours.Green;
             DeselectedColour = SelectedColour.Opacity(0.5f);
-            Text = @"random";
+            updateText();
 
             Action = () =>
             {
@@ -59,6 +60,44 @@ private void load(OsuColour colours)
             };
         }
 
+        protected override bool OnKeyDown(KeyDownEvent e)
+        {
+            updateText(e.ShiftPressed);
+            return base.OnKeyDown(e);
+        }
+
+        protected override void OnKeyUp(KeyUpEvent e)
+        {
+            updateText(e.ShiftPressed);
+            base.OnKeyUp(e);
+        }
+
+        protected override bool OnClick(ClickEvent e)
+        {
+            try
+            {
+                // this uses OR to handle rewinding when clicks are triggered by other sources (i.e. right button in OnMouseUp).
+                rewindSearch |= e.ShiftPressed;
+                return base.OnClick(e);
+            }
+            finally
+            {
+                rewindSearch = false;
+            }
+        }
+
+        protected override void OnMouseUp(MouseUpEvent e)
+        {
+            if (e.Button == MouseButton.Right)
+            {
+                rewindSearch = true;
+                TriggerClick();
+                return;
+            }
+
+            base.OnMouseUp(e);
+        }
+
         public override bool OnPressed(KeyBindingPressEvent<GlobalAction> e)
         {
             rewindSearch = e.Action == GlobalAction.SelectPreviousRandom;
@@ -79,5 +118,7 @@ public override void OnReleased(KeyBindingReleaseEvent<GlobalAction> e)
                 rewindSearch = false;
             }
         }
+
+        private void updateText(bool rewind = false) => Text = rewind ? "rewind" : "random";
     }
 }