osu! resume overlay

osu.Game.Rulesets.Osu/UI/OsuResumeOverlay.cs

@@ -0,0 +1,105 @@
+// 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 System;
+using osu.Framework.Allocation;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Cursor;
+using osu.Framework.Input.Bindings;
+using osu.Framework.Input.Events;
+using osu.Game.Graphics;
+using osu.Game.Rulesets.Osu.UI.Cursor;
+using osu.Game.Screens.Play;
+using osuTK;
+using osuTK.Graphics;
+
+namespace osu.Game.Rulesets.Osu.UI
+{
+    public class OsuResumeOverlay : ResumeOverlay
+    {
+        private OsuClickToResumeCursor clickToResumeCursor;
+
+        private GameplayCursorContainer localCursorContainer;
+
+        public override CursorContainer LocalCursor => State == Visibility.Visible ? localCursorContainer : null;
+
+        protected override string Message => "Click the orange cursor to resume";
+
+        [BackgroundDependencyLoader]
+        private void load(OsuColour colours)
+        {
+            Add(clickToResumeCursor = new OsuClickToResumeCursor { ResumeRequested = Resume });
+        }
+
+        public override void Show()
+        {
+            base.Show();
+            clickToResumeCursor.ShowAt(GameplayCursor.ActiveCursor.Position);
+            Add(localCursorContainer = new GameplayCursorContainer());
+        }
+
+        public override void Hide()
+        {
+            localCursorContainer.Expire();
+            base.Hide();
+        }
+
+        protected override bool OnHover(HoverEvent e) => true;
+
+        public class OsuClickToResumeCursor : OsuCursor, IKeyBindingHandler<OsuAction>
+        {
+            public override bool HandlePositionalInput => true;
+
+            public Action ResumeRequested;
+
+            public OsuClickToResumeCursor()
+            {
+                RelativePositionAxes = Axes.Both;
+            }
+
+            protected override bool OnHover(HoverEvent e)
+            {
+                updateColour();
+                return base.OnHover(e);
+            }
+
+            protected override void OnHoverLost(HoverLostEvent e)
+            {
+                updateColour();
+                base.OnHoverLost(e);
+            }
+
+            public bool OnPressed(OsuAction action)
+            {
+                switch (action)
+                {
+                    case OsuAction.LeftButton:
+                    case OsuAction.RightButton:
+                        if (!IsHovered) return false;
+
+                        this.ScaleTo(new Vector2(2), TRANSITION_TIME, Easing.OutQuint);
+
+                        ResumeRequested?.Invoke();
+                        return true;
+                }
+
+                return false;
+            }
+
+            public bool OnReleased(OsuAction action) => false;
+
+            public void ShowAt(Vector2 activeCursorPosition) => Schedule(() =>
+            {
+                updateColour();
+                this.MoveTo(activeCursorPosition);
+                this.ScaleTo(new Vector2(4)).Then().ScaleTo(Vector2.One, 1000, Easing.OutQuint);
+            });
+
+            private void updateColour()
+            {
+                this.FadeColour(IsHovered ? Color4.White : Color4.Orange, 400, Easing.OutQuint);
+            }
+        }
+    }
+}

osu.Game/Screens/Play/ResumeOverlay.cs

@@ -0,0 +1,74 @@
+// 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 System;
+using osu.Framework.Allocation;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Cursor;
+using osu.Game.Graphics;
+using osu.Game.Graphics.Sprites;
+using osuTK;
+using osuTK.Graphics;
+
+namespace osu.Game.Screens.Play
+{
+    /// <summary>
+    /// An overlay which can be used to require further user actions before gameplay is resumed.
+    /// </summary>
+    public abstract class ResumeOverlay : OverlayContainer
+    {
+        public CursorContainer GameplayCursor { get; set; }
+
+        /// <summary>
+        /// The action to be performed to complete resuming.
+        /// </summary>
+        public Action ResumeAction { private get; set; }
+
+        public virtual CursorContainer LocalCursor => null;
+
+        protected const float TRANSITION_TIME = 500;
+
+        protected override bool BlockPositionalInput => false;
+
+        protected abstract string Message { get; }
+
+        public override bool ReceivePositionalInputAt(Vector2 screenSpacePos) => true;
+
+        protected ResumeOverlay()
+        {
+            RelativeSizeAxes = Axes.Both;
+        }
+
+        protected void Resume()
+        {
+            ResumeAction?.Invoke();
+            Hide();
+        }
+
+        [BackgroundDependencyLoader]
+        private void load(OsuColour colours)
+        {
+            AddRange(new Drawable[]
+            {
+                new OsuSpriteText
+                {
+                    RelativePositionAxes = Axes.Both,
+                    Y = 0.4f,
+                    Text = Message,
+                    Font = OsuFont.GetFont(size: 30),
+                    Spacing = new Vector2(5, 0),
+                    Origin = Anchor.TopCentre,
+                    Anchor = Anchor.TopCentre,
+                    Colour = colours.Yellow,
+                    Shadow = true,
+                    ShadowColour = new Color4(0, 0, 0, 0.25f)
+                }
+            });
+        }
+
+        protected override void PopIn() => this.FadeIn(TRANSITION_TIME, Easing.OutQuint);
+
+        protected override void PopOut() => this.FadeOut(TRANSITION_TIME, Easing.OutQuint);
+    }
+}