Require holding back button to quit gameplay

Avoids accidental presses and streamlines logic with on-screen element.

osu.Game.Tests/Visual/TestCaseHoldForMenuButton.cs

@@ -13,25 +13,25 @@ using OpenTK.Input;
 namespace osu.Game.Tests.Visual
 {
     [Description("'Hold to Quit' UI element")]
-    public class TestCaseQuitButton : ManualInputManagerTestCase
+    public class TestCaseHoldForMenuButton : ManualInputManagerTestCase
     {
         private bool exitAction;
 
         [BackgroundDependencyLoader]
         private void load()
         {
-            QuitButton quitButton;
+            HoldForMenuButton holdForMenuButton;
 
-            Add(quitButton = new QuitButton
+            Add(holdForMenuButton = new HoldForMenuButton
             {
                 Origin = Anchor.BottomRight,
                 Anchor = Anchor.BottomRight,
                 Action = () => exitAction = true
             });
 
-            var text = quitButton.Children.OfType<SpriteText>().First();
+            var text = holdForMenuButton.Children.OfType<SpriteText>().First();
 
-            AddStep("Trigger text fade in", () => InputManager.MoveMouseTo(quitButton));
+            AddStep("Trigger text fade in", () => InputManager.MoveMouseTo(holdForMenuButton));
             AddUntilStep(() => text.IsPresent && !exitAction, "Text visible");
             AddStep("Trigger text fade out", () => InputManager.MoveMouseTo(Vector2.One));
             AddUntilStep(() => !text.IsPresent && !exitAction, "Text is not visible");
@@ -39,7 +39,7 @@ namespace osu.Game.Tests.Visual
             AddStep("Trigger exit action", () =>
             {
                 exitAction = false;
-                InputManager.MoveMouseTo(quitButton);
+                InputManager.MoveMouseTo(holdForMenuButton);
                 InputManager.PressButton(MouseButton.Left);
             });
 
@@ -47,7 +47,7 @@ namespace osu.Game.Tests.Visual
             AddAssert("action not triggered", () => !exitAction);
 
             AddStep("Trigger exit action", () => InputManager.PressButton(MouseButton.Left));
-            AddUntilStep(() => exitAction, $"{nameof(quitButton.Action)} was triggered");
+            AddUntilStep(() => exitAction, $"{nameof(holdForMenuButton.Action)} was triggered");
         }
     }
 }

osu.Game/Screens/Play/HUD/HoldForMenuButton.cs

@@ -8,16 +8,18 @@ using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Shapes;
 using osu.Framework.Graphics.UserInterface;
+using osu.Framework.Input.Bindings;
 using osu.Framework.Input.Events;
 using osu.Framework.MathUtils;
 using osu.Game.Graphics;
 using osu.Game.Graphics.Containers;
 using osu.Game.Graphics.Sprites;
+using osu.Game.Input.Bindings;
 using OpenTK;
 
 namespace osu.Game.Screens.Play.HUD
 {
-    public class QuitButton : FillFlowContainer
+    public class HoldForMenuButton : FillFlowContainer
     {
         public override bool ReceivePositionalInputAt(Vector2 screenSpacePos) => true;
 
@@ -30,7 +32,7 @@ namespace osu.Game.Screens.Play.HUD
 
         private readonly OsuSpriteText text;
 
-        public QuitButton()
+        public HoldForMenuButton()
         {
             Direction = FillDirection.Horizontal;
             Spacing = new Vector2(20, 0);
@@ -79,7 +81,7 @@ namespace osu.Game.Screens.Play.HUD
                     Alpha, MathHelper.Clamp(1 - positionalAdjust, 0.04f, 1), 0, 200, Easing.OutQuint);
         }
 
-        private class Button : HoldToConfirmContainer
+        private class Button : HoldToConfirmContainer, IKeyBindingHandler<GlobalAction>
         {
             private SpriteIcon icon;
             private CircularProgress circularProgress;
@@ -90,6 +92,30 @@ namespace osu.Game.Screens.Play.HUD
             public Action HoverGained;
             public Action HoverLost;
 
+            public bool OnPressed(GlobalAction action)
+            {
+                switch (action)
+                {
+                    case GlobalAction.Back:
+                        BeginConfirm();
+                        return true;
+                }
+
+                return false;
+            }
+
+            public bool OnReleased(GlobalAction action)
+            {
+                switch (action)
+                {
+                    case GlobalAction.Back:
+                        AbortConfirm();
+                        return true;
+                }
+
+                return false;
+            }
+
             [BackgroundDependencyLoader]
             private void load(OsuColour colours)
             {

osu.Game/Screens/Play/HUDOverlay.cs

@@ -34,7 +34,7 @@ namespace osu.Game.Screens.Play
         public readonly HealthDisplay HealthDisplay;
         public readonly SongProgress Progress;
         public readonly ModDisplay ModDisplay;
-        public readonly QuitButton HoldToQuit;
+        public readonly HoldForMenuButton HoldToQuit;
         public readonly PlayerSettingsOverlay PlayerSettingsOverlay;
 
         private Bindable<bool> showHud;
@@ -69,7 +69,7 @@ namespace osu.Game.Screens.Play
                         Children = new Drawable[]
                         {
                             KeyCounter = CreateKeyCounter(adjustableClock as IFrameBasedClock),
-                            HoldToQuit = CreateQuitButton(),
+                            HoldToQuit = CreateHoldForMenuButton(),
                         }
                     }
                 }
@@ -219,7 +219,7 @@ namespace osu.Game.Screens.Play
             RelativeSizeAxes = Axes.X,
         };
 
-        protected virtual QuitButton CreateQuitButton() => new QuitButton
+        protected virtual HoldForMenuButton CreateHoldForMenuButton() => new HoldForMenuButton
         {
             Anchor = Anchor.BottomRight,
             Origin = Anchor.BottomRight,

osu.Game/Screens/Play/Player.cs

@@ -35,6 +35,8 @@ namespace osu.Game.Screens.Play
 {
     public class Player : ScreenWithBeatmapBackground, IProvideCursor
     {
+        protected override bool AllowBackButton => false; // handled by HoldForMenuButton
+
         protected override float BackgroundParallaxAmount => 0.1f;
 
         protected override bool HideOverlaysOnEnter => true;