Merge pull request #2909 from tgi74/hit-shake

Add shake effect when clicking osu! hitobjects too early
Fix testcase dodginess
2026-05-14 17:02:53 +08:00 · 2018-08-24 16:04:43 +09:00 · 2018-08-24 15:50:39 +09:00 · 2018-08-24 15:27:13 +09:00 · 2018-08-24 15:26:46 +09:00 · 2018-08-24 15:26:36 +09:00
19 changed files with 148 additions and 48 deletions
@@ -25,9 +25,6 @@ namespace osu.Game.Rulesets.Mania.Beatmaps.Patterns.Legacy
                                         PatternType lastStair, IBeatmap originalBeatmap)
            : base(random, hitObject, beatmap, previousPattern, originalBeatmap)
        {
-            if (previousTime > hitObject.StartTime) throw new ArgumentOutOfRangeException(nameof(previousTime));
-            if (density < 0) throw new ArgumentOutOfRangeException(nameof(density));
-
            StairType = lastStair;

            TimingControlPoint timingPoint = beatmap.ControlPointInfo.TimingPointAt(hitObject.StartTime);
@@ -85,7 +85,7 @@ namespace osu.Game.Rulesets.Osu.Tests
            }
        }

-        private class TestDrawableHitCircle : DrawableHitCircle
+        protected class TestDrawableHitCircle : DrawableHitCircle
        {
            private readonly bool auto;

@@ -94,6 +94,8 @@ namespace osu.Game.Rulesets.Osu.Tests
                this.auto = auto;
            }

+            public void TriggerJudgement() => UpdateResult(true);
+
            protected override void CheckForResult(bool userTriggered, double timeOffset)
            {
                if (auto && !userTriggered && timeOffset > 0)
@@ -0,0 +1,23 @@
+// Copyright (c) 2007-2018 ppy Pty Ltd <contact@ppy.sh>.
+// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
+
+using osu.Framework.Graphics;
+using osu.Framework.MathUtils;
+using osu.Game.Rulesets.Scoring;
+
+namespace osu.Game.Rulesets.Osu.Tests
+{
+    public class TestCaseShaking : TestCaseHitCircle
+    {
+        public override void Add(Drawable drawable)
+        {
+            base.Add(drawable);
+
+            if (drawable is TestDrawableHitCircle hitObject)
+            {
+                Scheduler.AddDelayed(() => hitObject.TriggerJudgement(),
+                    hitObject.HitObject.StartTime - (hitObject.HitObject.HitWindows.HalfWindowFor(HitResult.Miss) + RNG.Next(0, 300)) - Time.Current);
+            }
+        }
+    }
+}
@@ -88,7 +88,10 @@ namespace osu.Game.Rulesets.Osu.Objects.Drawables

            var result = HitObject.HitWindows.ResultFor(timeOffset);
            if (result == HitResult.None)
+            {
+                Shake(Math.Abs(timeOffset) - HitObject.HitWindows.HalfWindowFor(HitResult.Miss));
                return;
+            }

            ApplyResult(r => r.Type = result);
        }
@@ -10,6 +10,7 @@ using osu.Game.Rulesets.Osu.Judgements;
 using osu.Game.Rulesets.Scoring;
 using osu.Game.Skinning;
 using OpenTK.Graphics;
+using osu.Game.Graphics.Containers;

 namespace osu.Game.Rulesets.Osu.Objects.Drawables
 {
@@ -17,12 +18,21 @@ namespace osu.Game.Rulesets.Osu.Objects.Drawables
    {
        public override bool IsPresent => base.IsPresent || State.Value == ArmedState.Idle && Time.Current >= HitObject.StartTime - HitObject.TimePreempt;

+        private readonly ShakeContainer shakeContainer;
+
        protected DrawableOsuHitObject(OsuHitObject hitObject)
            : base(hitObject)
        {
+            base.AddInternal(shakeContainer = new ShakeContainer { RelativeSizeAxes = Axes.Both });
            Alpha = 0;
        }

+        // Forward all internal management to shakeContainer.
+        // This is a bit ugly but we don't have the concept of InternalContent so it'll have to do for now. (https://github.com/ppy/osu-framework/issues/1690)
+        protected override void AddInternal(Drawable drawable) => shakeContainer.Add(drawable);
+        protected override void ClearInternal(bool disposeChildren = true) => shakeContainer.Clear(disposeChildren);
+        protected override bool RemoveInternal(Drawable drawable) => shakeContainer.Remove(drawable);
+
        protected sealed override void UpdateState(ArmedState state)
        {
            double transformTime = HitObject.StartTime - HitObject.TimePreempt;
@@ -68,6 +78,8 @@ namespace osu.Game.Rulesets.Osu.Objects.Drawables
        private OsuInputManager osuActionInputManager;
        internal OsuInputManager OsuActionInputManager => osuActionInputManager ?? (osuActionInputManager = GetContainingInputManager() as OsuInputManager);

+        protected virtual void Shake(double maximumLength) => shakeContainer.Shake(maximumLength);
+
        protected override JudgementResult CreateResult(Judgement judgement) => new OsuJudgementResult(judgement);
    }
 }
@@ -44,14 +44,17 @@ namespace osu.Game.Rulesets.Osu.Objects.Drawables
                },
                ticks = new Container<DrawableSliderTick> { RelativeSizeAxes = Axes.Both },
                repeatPoints = new Container<DrawableRepeatPoint> { RelativeSizeAxes = Axes.Both },
-                Ball = new SliderBall(s)
+                Ball = new SliderBall(s, this)
                {
                    BypassAutoSizeAxes = Axes.Both,
                    Scale = new Vector2(s.Scale),
                    AlwaysPresent = true,
                    Alpha = 0
                },
-                HeadCircle = new DrawableSliderHead(s, s.HeadCircle),
+                HeadCircle = new DrawableSliderHead(s, s.HeadCircle)
+                {
+                    OnShake = Shake
+                },
                TailCircle = new DrawableSliderTail(s, s.TailCircle)
            };

@@ -1,6 +1,7 @@
 // Copyright (c) 2007-2018 ppy Pty Ltd <contact@ppy.sh>.
 // Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE

+using System;
 using osu.Game.Rulesets.Objects.Types;
 using OpenTK;

@@ -28,5 +29,9 @@ namespace osu.Game.Rulesets.Osu.Objects.Drawables
            if (!IsHit)
                Position = slider.CurvePositionAt(completionProgress);
        }
+
+        public Action<double> OnShake;
+
+        protected override void Shake(double maximumLength) => OnShake?.Invoke(maximumLength);
    }
 }
@@ -36,9 +36,11 @@ namespace osu.Game.Rulesets.Osu.Objects.Drawables.Pieces
        private readonly Slider slider;
        public readonly Drawable FollowCircle;
        private Drawable drawableBall;
+        private readonly DrawableSlider drawableSlider;

-        public SliderBall(Slider slider)
+        public SliderBall(Slider slider, DrawableSlider drawableSlider = null)
        {
+            this.drawableSlider = drawableSlider;
            this.slider = slider;
            Masking = true;
            AutoSizeAxes = Axes.Both;
@@ -155,7 +157,7 @@ namespace osu.Game.Rulesets.Osu.Objects.Drawables.Pieces
                Tracking = canCurrentlyTrack
                           && lastState != null
                           && ReceiveMouseInputAt(lastState.Mouse.NativeState.Position)
-                           && ((Parent as DrawableSlider)?.OsuActionInputManager?.PressedActions.Any(x => x == OsuAction.LeftButton || x == OsuAction.RightButton) ?? false);
+                           && (drawableSlider?.OsuActionInputManager?.PressedActions.Any(x => x == OsuAction.LeftButton || x == OsuAction.RightButton) ?? false);
            }
        }

@@ -25,7 +25,7 @@ namespace osu.Game.Tests.Visual
        [BackgroundDependencyLoader]
        private void load()
        {
-            AddInternal(trackManager);
+            Add(trackManager);
        }

        [Test]
@@ -75,7 +75,7 @@ namespace osu.Game.Tests.Visual
            TestTrackOwner owner = null;
            PreviewTrack track = null;

-            AddStep("get track", () => AddInternal(owner = new TestTrackOwner(track = getTrack())));
+            AddStep("get track", () => Add(owner = new TestTrackOwner(track = getTrack())));
            AddStep("start", () => track.Start());
            AddStep("attempt stop", () => trackManager.StopAnyPlaying(this));
            AddAssert("not stopped", () => track.IsRunning);
@@ -89,7 +89,7 @@ namespace osu.Game.Tests.Visual
        {
            var track = getTrack();

-            AddInternal(track);
+            Add(track);

            return track;
        }
@@ -351,7 +351,11 @@ namespace osu.Game.Beatmaps
            // let's make sure there are actually .osu files to import.
            string mapName = reader.Filenames.FirstOrDefault(f => f.EndsWith(".osu"));
            if (string.IsNullOrEmpty(mapName))
-                throw new InvalidOperationException($"No beatmap files found in this beatmap archive ({reader.Name}).");
+            {
+                // Todo: This is temporary for debugging purposes
+                var files = reader.Filenames.ToList();
+                throw new InvalidOperationException($"No beatmap files found in this beatmap archive. Files ({files.Count}): {string.Join(", ", files)}");
+            }

            Beatmap beatmap;
            using (var stream = new StreamReader(reader.GetStream(mapName)))
@@ -55,11 +55,11 @@ namespace osu.Game.Beatmaps.Formats
            } while (line != null && line.Length == 0);

            if (line == null)
-                throw new IOException(@"Unknown file format");
+                throw new IOException(@"Unknown file format (null)");

-            var decoder = typedDecoders.Select(d => line.StartsWith(d.Key) ? d.Value : null).FirstOrDefault();
+            var decoder = typedDecoders.Select(d => line.StartsWith(d.Key, StringComparison.InvariantCulture) ? d.Value : null).FirstOrDefault();
            if (decoder == null)
-                throw new IOException(@"Unknown file format");
+                throw new IOException($@"Unknown file format ({line})");

            return (Decoder<T>)decoder.Invoke(line);
        }
@@ -0,0 +1,39 @@
+// Copyright (c) 2007-2018 ppy Pty Ltd <contact@ppy.sh>.
+// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
+
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+
+namespace osu.Game.Graphics.Containers
+{
+    /// <summary>
+    /// A container that adds the ability to shake its contents.
+    /// </summary>
+    public class ShakeContainer : Container
+    {
+        /// <summary>
+        /// Shake the contents of this container.
+        /// </summary>
+        /// <param name="maximumLength">The maximum length the shake should last.</param>
+        public void Shake(double maximumLength)
+        {
+            const float shake_amount = 8;
+            const float shake_duration = 30;
+
+            // if we don't have enough time, don't bother shaking.
+            if (maximumLength < shake_duration * 2)
+                return;
+
+            var sequence = this.MoveToX(shake_amount, shake_duration / 2, Easing.OutSine).Then()
+                               .MoveToX(-shake_amount, shake_duration, Easing.InOutSine).Then();
+
+            // if we don't have enough time for the second shake, skip it.
+            if (maximumLength > shake_duration * 4)
+                sequence = sequence
+                           .MoveToX(shake_amount, shake_duration, Easing.InOutSine).Then()
+                           .MoveToX(-shake_amount, shake_duration, Easing.InOutSine).Then();
+
+            sequence.MoveToX(0, shake_duration / 2, Easing.InSine);
+        }
+    }
+}
@@ -96,8 +96,7 @@ namespace osu.Game.Overlays
            base.LoadComplete();

            StateChanged += _ => updateProcessingMode();
-            OverlayActivationMode.ValueChanged += _ => updateProcessingMode();
-            OverlayActivationMode.TriggerChange();
+            OverlayActivationMode.BindValueChanged(_ => updateProcessingMode(), true);
        }

        private int totalCount => sections.Select(c => c.DisplayedCount).Sum();
@@ -9,6 +9,7 @@ using osu.Framework.Graphics.Shaders;
 using osu.Game.Screens.Menu;
 using OpenTK;
 using osu.Framework.Screens;
+using osu.Game.Overlays;

 namespace osu.Game.Screens
 {
@@ -18,6 +19,8 @@ namespace osu.Game.Screens

        protected override bool HideOverlaysOnEnter => true;

+        protected override OverlayActivation InitialOverlayActivationMode => OverlayActivation.Disabled;
+
        protected override bool AllowBackButton => false;

        public Loader()
@@ -174,6 +174,9 @@ namespace osu.Game.Screens.Menu
                ButtonSystemState lastState = state;
                state = value;

+                if (game != null)
+                    game.OverlayActivationMode.Value = state == ButtonSystemState.Exit ? OverlayActivation.Disabled : OverlayActivation.All;
+
                updateLogoState(lastState);

                Logger.Log($"{nameof(ButtonSystem)}'s state changed from {lastState} to {state}");
@@ -205,11 +208,7 @@ namespace osu.Game.Screens.Menu
                        {
                            logoTracking = false;

-                            if (game != null)
-                            {
-                                game.OverlayActivationMode.Value = state == ButtonSystemState.Exit ? OverlayActivation.Disabled : OverlayActivation.All;
-                                game.Toolbar.Hide();
-                            }
+                            game?.Toolbar.Hide();

                            logo.ClearTransforms(targetMember: nameof(Position));
                            logo.RelativePositionAxes = Axes.Both;
@@ -243,11 +242,7 @@ namespace osu.Game.Screens.Menu
                                if (impact)
                                    logo.Impact();

-                                if (game != null)
-                                {
-                                    game.OverlayActivationMode.Value = OverlayActivation.All;
-                                    game.Toolbar.State = Visibility.Visible;
-                                }
+                                game?.Toolbar.Show();
                            }, 200);
                            break;
                        default:
@@ -31,23 +31,30 @@ namespace osu.Game.Screens.Play.Break
            RelativeSizeAxes = Axes.Both;
            InternalChildren = new Drawable[]
            {
-                leftGlowIcon = new GlowIcon
+                new ParallaxContainer
                {
-                    Anchor = Anchor.Centre,
-                    Origin = Anchor.CentreRight,
-                    X = -glow_icon_offscreen_offset,
-                    Icon = Graphics.FontAwesome.fa_chevron_right,
-                    BlurSigma = new Vector2(glow_icon_blur_sigma),
-                    Size = new Vector2(glow_icon_size),
-                },
-                rightGlowIcon = new GlowIcon
-                {
-                    Anchor = Anchor.Centre,
-                    Origin = Anchor.CentreLeft,
-                    X = glow_icon_offscreen_offset,
-                    Icon = Graphics.FontAwesome.fa_chevron_left,
-                    BlurSigma = new Vector2(glow_icon_blur_sigma),
-                    Size = new Vector2(glow_icon_size),
+                    ParallaxAmount = -0.01f,
+                    Children = new Drawable[]
+                    {
+                        leftGlowIcon = new GlowIcon
+                        {
+                            Anchor = Anchor.Centre,
+                            Origin = Anchor.CentreRight,
+                            X = -glow_icon_offscreen_offset,
+                            Icon = Graphics.FontAwesome.fa_chevron_right,
+                            BlurSigma = new Vector2(glow_icon_blur_sigma),
+                            Size = new Vector2(glow_icon_size),
+                        },
+                        rightGlowIcon = new GlowIcon
+                        {
+                            Anchor = Anchor.Centre,
+                            Origin = Anchor.CentreLeft,
+                            X = glow_icon_offscreen_offset,
+                            Icon = Graphics.FontAwesome.fa_chevron_left,
+                            BlurSigma = new Vector2(glow_icon_blur_sigma),
+                            Size = new Vector2(glow_icon_size),
+                        },
+                    }
                },
                new ParallaxContainer
                {
@@ -85,12 +85,10 @@ namespace osu.Game.Skinning
        private void load(OsuConfigManager config)
        {
            beatmapSkins = config.GetBindable<bool>(OsuSetting.BeatmapSkins);
-            beatmapSkins.ValueChanged += val => onSourceChanged();
-            beatmapSkins.TriggerChange();
+            beatmapSkins.BindValueChanged(_ => onSourceChanged());

            beatmapHitsounds = config.GetBindable<bool>(OsuSetting.BeatmapHitsounds);
-            beatmapHitsounds.ValueChanged += val => onSourceChanged();
-            beatmapHitsounds.TriggerChange();
+            beatmapHitsounds.BindValueChanged(_ => onSourceChanged(), true);
        }

        protected override void LoadComplete()
@@ -52,5 +52,13 @@ namespace osu.Game.Skinning
        protected virtual void SkinChanged(ISkinSource skin, bool allowFallback)
        {
        }
+
+        protected override void Dispose(bool isDisposing)
+        {
+            base.Dispose(isDisposing);
+
+            if (skin != null)
+                skin.SourceChanged -= onChange;
+        }
    }
 }
@@ -18,7 +18,7 @@
    <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="2.1.1" />
    <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite.Core" Version="2.1.1" />
    <PackageReference Include="Newtonsoft.Json" Version="11.0.2" />
-    <PackageReference Include="ppy.osu.Framework" Version="2018.821.0" />
+    <PackageReference Include="ppy.osu.Framework" Version="2018.824.0" />
    <PackageReference Include="SharpCompress" Version="0.22.0" />
    <PackageReference Include="NUnit" Version="3.10.1" />
    <PackageReference Include="SharpRaven" Version="2.4.0" />