Merge branch 'master' into comments-footer-colours

osu.Game.Rulesets.Osu.Tests/TestSceneDrawableJudgement.cs

@@ -4,62 +4,109 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using NUnit.Framework;
+using osu.Framework.Allocation;
 using osu.Framework.Extensions;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Pooling;
+using osu.Framework.Testing;
+using osu.Game.Configuration;
 using osu.Game.Rulesets.Judgements;
 using osu.Game.Rulesets.Objects;
 using osu.Game.Rulesets.Osu.Objects.Drawables;
 using osu.Game.Rulesets.Scoring;
+using osu.Game.Skinning;
 
 namespace osu.Game.Rulesets.Osu.Tests
 {
     public class TestSceneDrawableJudgement : OsuSkinnableTestScene
     {
+        [Resolved]
+        private OsuConfigManager config { get; set; }
+
+        private readonly List<DrawablePool<TestDrawableOsuJudgement>> pools;
+
         public TestSceneDrawableJudgement()
         {
-            var pools = new List<DrawablePool<DrawableOsuJudgement>>();
+            pools = new List<DrawablePool<TestDrawableOsuJudgement>>();
 
             foreach (HitResult result in Enum.GetValues(typeof(HitResult)).OfType<HitResult>().Skip(1))
+                showResult(result);
+        }
+
+        [Test]
+        public void TestHitLightingDisabled()
+        {
+            AddStep("hit lighting disabled", () => config.Set(OsuSetting.HitLighting, false));
+
+            showResult(HitResult.Great);
+
+            AddUntilStep("judgements shown", () => this.ChildrenOfType<TestDrawableOsuJudgement>().Any());
+            AddAssert("judgement body immediately visible",
+                () => this.ChildrenOfType<TestDrawableOsuJudgement>().All(judgement => judgement.JudgementBody.Alpha == 1));
+            AddAssert("hit lighting hidden",
+                () => this.ChildrenOfType<TestDrawableOsuJudgement>().All(judgement => judgement.Lighting.Alpha == 0));
+        }
+
+        [Test]
+        public void TestHitLightingEnabled()
+        {
+            AddStep("hit lighting enabled", () => config.Set(OsuSetting.HitLighting, true));
+
+            showResult(HitResult.Great);
+
+            AddUntilStep("judgements shown", () => this.ChildrenOfType<TestDrawableOsuJudgement>().Any());
+            AddAssert("judgement body not immediately visible",
+                () => this.ChildrenOfType<TestDrawableOsuJudgement>().All(judgement => judgement.JudgementBody.Alpha > 0 && judgement.JudgementBody.Alpha < 1));
+            AddAssert("hit lighting shown",
+                () => this.ChildrenOfType<TestDrawableOsuJudgement>().All(judgement => judgement.Lighting.Alpha > 0));
+        }
+
+        private void showResult(HitResult result)
+        {
+            AddStep("Show " + result.GetDescription(), () =>
             {
-                AddStep("Show " + result.GetDescription(), () =>
+                int poolIndex = 0;
+
+                SetContents(() =>
                 {
-                    int poolIndex = 0;
+                    DrawablePool<TestDrawableOsuJudgement> pool;
 
-                    SetContents(() =>
+                    if (poolIndex >= pools.Count)
+                        pools.Add(pool = new DrawablePool<TestDrawableOsuJudgement>(1));
+                    else
                     {
-                        DrawablePool<DrawableOsuJudgement> pool;
+                        pool = pools[poolIndex];
 
-                        if (poolIndex >= pools.Count)
+                        // We need to make sure neither the pool nor the judgement get disposed when new content is set, and they both share the same parent.
-                            pools.Add(pool = new DrawablePool<DrawableOsuJudgement>(1));
+                        ((Container)pool.Parent).Clear(false);
-                        else
+                    }
+
+                    var container = new Container
+                    {
+                        RelativeSizeAxes = Axes.Both,
+                        Children = new Drawable[]
                         {
-                            pool = pools[poolIndex];
+                            pool,
-
+                            pool.Get(j => j.Apply(new JudgementResult(new HitObject(), new Judgement()) { Type = result }, null)).With(j =>
-                            // We need to make sure neither the pool nor the judgement get disposed when new content is set, and they both share the same parent.
-                            ((Container)pool.Parent).Clear(false);
-                        }
-
-                        var container = new Container
-                        {
-                            RelativeSizeAxes = Axes.Both,
-                            Children = new Drawable[]
                             {
-                                pool,
+                                j.Anchor = Anchor.Centre;
-                                pool.Get(j => j.Apply(new JudgementResult(new HitObject(), new Judgement()) { Type = result }, null)).With(j =>
+                                j.Origin = Anchor.Centre;
-                                {
+                            })
-                                    j.Anchor = Anchor.Centre;
+                        }
-                                    j.Origin = Anchor.Centre;
+                    };
-                                })
-                            }
-                        };
 
-                        poolIndex++;
+                    poolIndex++;
-                        return container;
+                    return container;
-                    });
                 });
-            }
+            });
+        }
+
+        private class TestDrawableOsuJudgement : DrawableOsuJudgement
+        {
+            public new SkinnableSprite Lighting => base.Lighting;
+            public new Container JudgementBody => base.JudgementBody;
         }
     }
 }

osu.Game.Rulesets.Osu.Tests/TestSceneSpinnerRotation.cs

@@ -142,7 +142,7 @@ namespace osu.Game.Rulesets.Osu.Tests
             {
                 // multipled by 2 to nullify the score multiplier. (autoplay mod selected)
                 var totalScore = ((ScoreExposedPlayer)Player).ScoreProcessor.TotalScore.Value * 2;
-                return totalScore == (int)(drawableSpinner.Disc.CumulativeRotation / 360) * 100;
+                return totalScore == (int)(drawableSpinner.Disc.CumulativeRotation / 360) * SpinnerTick.SCORE_PER_TICK;
             });
 
             addSeekStep(0);

osu.Game.Rulesets.Osu/Objects/Drawables/DrawableOsuJudgement.cs

@@ -16,9 +16,13 @@ namespace osu.Game.Rulesets.Osu.Objects.Drawables
 {
     public class DrawableOsuJudgement : DrawableJudgement
     {
-        private SkinnableSprite lighting;
+        protected SkinnableSprite Lighting;
+
         private Bindable<Color4> lightingColour;
 
+        [Resolved]
+        private OsuConfigManager config { get; set; }
+
         public DrawableOsuJudgement(JudgementResult result, DrawableHitObject judgedObject)
             : base(result, judgedObject)
         {
@@ -29,18 +33,16 @@ namespace osu.Game.Rulesets.Osu.Objects.Drawables
         }
 
         [BackgroundDependencyLoader]
-        private void load(OsuConfigManager config)
+        private void load()
         {
-            if (config.Get<bool>(OsuSetting.HitLighting))
+            AddInternal(Lighting = new SkinnableSprite("lighting")
             {
-                AddInternal(lighting = new SkinnableSprite("lighting")
+                Anchor = Anchor.Centre,
-                {
+                Origin = Anchor.Centre,
-                    Anchor = Anchor.Centre,
+                Blending = BlendingParameters.Additive,
-                    Origin = Anchor.Centre,
+                Depth = float.MaxValue,
-                    Blending = BlendingParameters.Additive,
+                Alpha = 0
-                    Depth = float.MaxValue
+            });
-                });
-            }
         }
 
         public override void Apply(JudgementResult result, DrawableHitObject judgedObject)
@@ -60,33 +62,39 @@ namespace osu.Game.Rulesets.Osu.Objects.Drawables
 
             lightingColour?.UnbindAll();
 
-            if (lighting != null)
+            Lighting.ResetAnimation();
-            {
-                lighting.ResetAnimation();
 
-                if (JudgedObject != null)
+            if (JudgedObject != null)
-                {
+            {
-                    lightingColour = JudgedObject.AccentColour.GetBoundCopy();
+                lightingColour = JudgedObject.AccentColour.GetBoundCopy();
-                    lightingColour.BindValueChanged(colour => lighting.Colour = Result.Type == HitResult.Miss ? Color4.Transparent : colour.NewValue, true);
+                lightingColour.BindValueChanged(colour => Lighting.Colour = Result.Type == HitResult.Miss ? Color4.Transparent : colour.NewValue, true);
-                }
+            }
-                else
+            else
-                {
+            {
-                    lighting.Colour = Color4.White;
+                Lighting.Colour = Color4.White;
-                }
             }
         }
 
-        protected override double FadeOutDelay => lighting == null ? base.FadeOutDelay : 1400;
+        private double fadeOutDelay;
+        protected override double FadeOutDelay => fadeOutDelay;
 
         protected override void ApplyHitAnimations()
         {
-            if (lighting != null)
+            bool hitLightingEnabled = config.Get<bool>(OsuSetting.HitLighting);
+
+            if (hitLightingEnabled)
             {
                 JudgementBody.FadeIn().Delay(FadeInDuration).FadeOut(400);
 
-                lighting.ScaleTo(0.8f).ScaleTo(1.2f, 600, Easing.Out);
+                Lighting.ScaleTo(0.8f).ScaleTo(1.2f, 600, Easing.Out);
-                lighting.FadeIn(200).Then().Delay(200).FadeOut(1000);
+                Lighting.FadeIn(200).Then().Delay(200).FadeOut(1000);
             }
+            else
+            {
+                JudgementBody.Alpha = 1;
+            }
+
+            fadeOutDelay = hitLightingEnabled ? 1400 : base.FadeOutDelay;
 
             JudgementText?.TransformSpacingTo(Vector2.Zero).Then().TransformSpacingTo(new Vector2(14, 0), 1800, Easing.OutQuint);
             base.ApplyHitAnimations();

osu.Game.Rulesets.Osu/Objects/Drawables/Pieces/SpinnerBonusDisplay.cs

@@ -36,7 +36,7 @@ namespace osu.Game.Rulesets.Osu.Objects.Drawables.Pieces
                 return;
 
             displayedCount = count;
-            bonusCounter.Text = $"{1000 * count}";
+            bonusCounter.Text = $"{SpinnerBonusTick.SCORE_PER_TICK * count}";
             bonusCounter.FadeOutFromOne(1500);
             bonusCounter.ScaleTo(1.5f).Then().ScaleTo(1f, 1000, Easing.OutQuint);
         }

osu.Game.Rulesets.Osu/Objects/SpinnerBonusTick.cs

@@ -9,6 +9,8 @@ namespace osu.Game.Rulesets.Osu.Objects
 {
     public class SpinnerBonusTick : SpinnerTick
     {
+        public new const int SCORE_PER_TICK = 50;
+
         public SpinnerBonusTick()
         {
             Samples.Add(new HitSampleInfo { Name = "spinnerbonus" });
@@ -18,7 +20,7 @@ namespace osu.Game.Rulesets.Osu.Objects
 
         public class OsuSpinnerBonusTickJudgement : OsuSpinnerTickJudgement
         {
-            protected override int NumericResultFor(HitResult result) => 1100;
+            protected override int NumericResultFor(HitResult result) => SCORE_PER_TICK;
 
             protected override double HealthIncreaseFor(HitResult result) => base.HealthIncreaseFor(result) * 2;
         }

osu.Game.Rulesets.Osu/Objects/SpinnerTick.cs

@@ -9,6 +9,8 @@ namespace osu.Game.Rulesets.Osu.Objects
 {
     public class SpinnerTick : OsuHitObject
     {
+        public const int SCORE_PER_TICK = 10;
+
         public override Judgement CreateJudgement() => new OsuSpinnerTickJudgement();
 
         protected override HitWindows CreateHitWindows() => HitWindows.Empty;
@@ -17,7 +19,7 @@ namespace osu.Game.Rulesets.Osu.Objects
         {
             public override bool AffectsCombo => false;
 
-            protected override int NumericResultFor(HitResult result) => 100;
+            protected override int NumericResultFor(HitResult result) => SCORE_PER_TICK;
 
             protected override double HealthIncreaseFor(HitResult result) => result == MaxResult ? 0.6 * base.HealthIncreaseFor(result) : 0;
         }

osu.Game.Tests/Visual/Gameplay/TestScenePause.cs

@@ -11,6 +11,7 @@ using osu.Game.Graphics.Containers;
 using osu.Game.Graphics.Cursor;
 using osu.Game.Rulesets;
 using osu.Game.Screens.Play;
+using osu.Game.Skinning;
 using osuTK;
 using osuTK.Input;
 
@@ -221,6 +222,31 @@ namespace osu.Game.Tests.Visual.Gameplay
             confirmExited();
         }
 
+        [Test]
+        public void TestPauseSoundLoop()
+        {
+            AddStep("seek before gameplay", () => Player.GameplayClockContainer.Seek(-5000));
+
+            SkinnableSound getLoop() => Player.ChildrenOfType<PauseOverlay>().FirstOrDefault()?.ChildrenOfType<SkinnableSound>().FirstOrDefault();
+
+            pauseAndConfirm();
+            AddAssert("loop is playing", () => getLoop().IsPlaying);
+
+            resumeAndConfirm();
+            AddUntilStep("loop is stopped", () => !getLoop().IsPlaying);
+
+            AddUntilStep("pause again", () =>
+            {
+                Player.Pause();
+                return !Player.GameplayClockContainer.GameplayClock.IsRunning;
+            });
+
+            AddAssert("loop is playing", () => getLoop().IsPlaying);
+
+            resumeAndConfirm();
+            AddUntilStep("loop is stopped", () => !getLoop().IsPlaying);
+        }
+
         private void pauseAndConfirm()
         {
             pause();

osu.Game/Rulesets/Judgements/DrawableJudgement.cs

@@ -130,7 +130,11 @@ namespace osu.Game.Rulesets.Judgements
             if (type == currentDrawableType)
                 return;
 
-            InternalChild = JudgementBody = new Container
+            // sub-classes might have added their own children that would be removed here if .InternalChild was used.
+            if (JudgementBody != null)
+                RemoveInternal(JudgementBody);
+
+            AddInternal(JudgementBody = new Container
             {
                 Anchor = Anchor.Centre,
                 Origin = Anchor.Centre,
@@ -142,7 +146,7 @@ namespace osu.Game.Rulesets.Judgements
                     Colour = colours.ForHitResult(type),
                     Scale = new Vector2(0.85f, 1),
                 }, confineMode: ConfineMode.NoScaling)
-            };
+            });
 
             currentDrawableType = type;
         }

osu.Game/Screens/Play/GameplayMenuOverlay.cs

@@ -24,7 +24,8 @@ namespace osu.Game.Screens.Play
 {
     public abstract class GameplayMenuOverlay : OverlayContainer, IKeyBindingHandler<GlobalAction>
     {
-        private const int transition_duration = 200;
+        protected const int TRANSITION_DURATION = 200;
+
         private const int button_height = 70;
         private const float background_alpha = 0.75f;
 
@@ -156,8 +157,8 @@ namespace osu.Game.Screens.Play
             }
         }
 
-        protected override void PopIn() => this.FadeIn(transition_duration, Easing.In);
+        protected override void PopIn() => this.FadeIn(TRANSITION_DURATION, Easing.In);
-        protected override void PopOut() => this.FadeOut(transition_duration, Easing.In);
+        protected override void PopOut() => this.FadeOut(TRANSITION_DURATION, Easing.In);
 
         // Don't let mouse down events through the overlay or people can click circles while paused.
         protected override bool OnMouseDown(MouseDownEvent e) => true;

osu.Game/Screens/Play/PauseOverlay.cs

@@ -4,7 +4,10 @@
 using System;
 using System.Linq;
 using osu.Framework.Allocation;
+using osu.Framework.Graphics;
+using osu.Game.Audio;
 using osu.Game.Graphics;
+using osu.Game.Skinning;
 using osuTK.Graphics;
 
 namespace osu.Game.Screens.Play
@@ -13,17 +16,46 @@ namespace osu.Game.Screens.Play
     {
         public Action OnResume;
 
+        public override bool IsPresent => base.IsPresent || pauseLoop.IsPlaying;
+
         public override string Header => "paused";
         public override string Description => "you're not going to do what i think you're going to do, are ya?";
 
+        private SkinnableSound pauseLoop;
+
         protected override Action BackAction => () => InternalButtons.Children.First().Click();
 
+        private const float minimum_volume = 0.0001f;
+
         [BackgroundDependencyLoader]
         private void load(OsuColour colours)
         {
             AddButton("Continue", colours.Green, () => OnResume?.Invoke());
             AddButton("Retry", colours.YellowDark, () => OnRetry?.Invoke());
             AddButton("Quit", new Color4(170, 27, 39, 255), () => OnQuit?.Invoke());
+
+            AddInternal(pauseLoop = new SkinnableSound(new SampleInfo("pause-loop"))
+            {
+                Looping = true,
+            });
+
+            // SkinnableSound only plays a sound if its aggregate volume is > 0, so the volume must be turned up before playing it
+            pauseLoop.VolumeTo(minimum_volume);
+        }
+
+        protected override void PopIn()
+        {
+            base.PopIn();
+
+            pauseLoop.VolumeTo(1.0f, TRANSITION_DURATION, Easing.InQuint);
+            pauseLoop.Play();
+        }
+
+        protected override void PopOut()
+        {
+            base.PopOut();
+
+            pauseLoop.VolumeTo(minimum_volume, TRANSITION_DURATION, Easing.OutQuad).Finally(_ => pauseLoop.Stop());
         }
     }
 }

osu.Game/Skinning/SkinnableSound.cs

@@ -48,6 +48,10 @@ namespace osu.Game.Skinning
 
         public BindableNumber<double> Tempo => samplesContainer.Tempo;
 
+        public override bool IsPresent => Scheduler.HasPendingTasks || IsPlaying;
+
+        public bool IsPlaying => samplesContainer.Any(s => s.Playing);
+
         /// <summary>
         /// Smoothly adjusts <see cref="Volume"/> over time.
         /// </summary>
@@ -97,8 +101,6 @@ namespace osu.Game.Skinning
 
         public void Stop() => samplesContainer.ForEach(c => c.Stop());
 
-        public override bool IsPresent => Scheduler.HasPendingTasks;
-
         protected override void SkinChanged(ISkinSource skin, bool allowFallback)
         {
             bool wasPlaying = samplesContainer.Any(s => s.Playing);

osu.Game/Tests/Visual/OsuTestScene.cs

@@ -305,8 +305,10 @@ namespace osu.Game.Tests.Visual
                     {
                         double refTime = referenceClock.CurrentTime;
 
-                        if (lastReferenceTime.HasValue)
+                        double? lastRefTime = lastReferenceTime;
-                            accumulated += (refTime - lastReferenceTime.Value) * Rate;
+
+                        if (lastRefTime != null)
+                            accumulated += (refTime - lastRefTime.Value) * Rate;
 
                         lastReferenceTime = refTime;
                     }

osu.Game/osu.Game.csproj

@@ -26,8 +26,8 @@
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
     <PackageReference Include="ppy.osu.Framework" Version="2020.723.0" />
     <PackageReference Include="ppy.osu.Game.Resources" Version="2020.727.1" />
-    <PackageReference Include="Sentry" Version="2.1.4" />
+    <PackageReference Include="Sentry" Version="2.1.5" />
-    <PackageReference Include="SharpCompress" Version="0.25.1" />
+    <PackageReference Include="SharpCompress" Version="0.26.0" />
     <PackageReference Include="NUnit" Version="3.12.0" />
     <PackageReference Include="System.ComponentModel.Annotations" Version="4.7.0" />
   </ItemGroup>

osu.iOS.props

@@ -81,7 +81,7 @@
     <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite.Core" Version="2.2.6" />
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
     <PackageReference Include="ppy.osu.Framework" Version="2020.723.0" />
-    <PackageReference Include="SharpCompress" Version="0.25.1" />
+    <PackageReference Include="SharpCompress" Version="0.26.0" />
     <PackageReference Include="NUnit" Version="3.12.0" />
     <PackageReference Include="SharpRaven" Version="2.4.0" />
     <PackageReference Include="System.ComponentModel.Annotations" Version="4.7.0" />