Merge pull request #33503 from bdach/rank-change-sample-toggling

Prevent rank display shown in skin editor toolbox from playing samples

Author: peppy

osu.Game/Localisation/DefaultRankDisplayStrings.cs

@@ -0,0 +1,19 @@
+// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using osu.Framework.Localisation;
+
+namespace osu.Game.Localisation
+{
+    public static class DefaultRankDisplayStrings
+    {
+        private const string prefix = @"osu.Game.Resources.Localisation.DefaultRankDisplay";
+
+        /// <summary>
+        /// "Play samples on rank change"
+        /// </summary>
+        public static LocalisableString PlaySamplesOnRankChange => new TranslatableString(getKey(@"play_samples_on_rank_change"), @"Play samples on rank change");
+
+        private static string getKey(string key) => $@"{prefix}:{key}";
+    }
+}

osu.Game/Overlays/SkinEditor/SkinComponentToolbox.cs

@@ -219,7 +219,7 @@ protected override bool OnClick(ClickEvent e)
             }
         }
 
-        public partial class DependencyBorrowingContainer : Container
+        private partial class DependencyBorrowingContainer : Container
         {
             protected override bool ShouldBeConsideredForInput(Drawable child) => false;
 
@@ -232,8 +232,19 @@ public DependencyBorrowingContainer(CompositeDrawable? donor)
                 this.donor = donor;
             }
 
-            protected override IReadOnlyDependencyContainer CreateChildDependencies(IReadOnlyDependencyContainer parent) =>
-                new DependencyContainer(donor?.Dependencies ?? base.CreateChildDependencies(parent));
+            protected override IReadOnlyDependencyContainer CreateChildDependencies(IReadOnlyDependencyContainer parent)
+            {
+                var baseDependencies = base.CreateChildDependencies(parent);
+                if (donor == null)
+                    return baseDependencies;
+
+                var dependencies = new DependencyContainer(donor.Dependencies);
+                // inject `SkinEditor` again *on top* of the borrowed dependencies.
+                // this is designed to let components know when they are being displayed in the context of the skin editor
+                // via attempting to resolve `SkinEditor`.
+                dependencies.CacheAs(baseDependencies.Get<SkinEditor>());
+                return dependencies;
+            }
         }
     }
 }

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

@@ -6,11 +6,14 @@
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Game.Audio;
+using osu.Game.Configuration;
 using osu.Game.Online.Leaderboards;
+using osu.Game.Overlays.SkinEditor;
 using osu.Game.Rulesets.Scoring;
 using osu.Game.Scoring;
 using osu.Game.Skinning;
 using osuTK;
+using osu.Game.Localisation;
 
 namespace osu.Game.Screens.Play.HUD
 {
@@ -19,6 +22,9 @@ public partial class DefaultRankDisplay : CompositeDrawable, ISerialisableDrawab
         [Resolved]
         private ScoreProcessor scoreProcessor { get; set; } = null!;
 
+        [SettingSource(typeof(DefaultRankDisplayStrings), nameof(DefaultRankDisplayStrings.PlaySamplesOnRankChange))]
+        public BindableBool PlaySamples { get; set; } = new BindableBool(true);
+
         public bool UsesFixedAnchor { get; set; }
 
         private UpdateableRank rankDisplay = null!;
@@ -34,7 +40,7 @@ public DefaultRankDisplay()
         }
 
         [BackgroundDependencyLoader]
-        private void load()
+        private void load(SkinEditor? skinEditor)
         {
             InternalChildren = new Drawable[]
             {
@@ -45,6 +51,9 @@ private void load()
                     RelativeSizeAxes = Axes.Both
                 },
             };
+
+            if (skinEditor != null)
+                PlaySamples.Value = false;
         }
 
         protected override void LoadComplete()
@@ -55,7 +64,7 @@ protected override void LoadComplete()
             rank.BindValueChanged(r =>
             {
                 // Don't play rank-down sfx on quit/retry
-                if (r.NewValue != r.OldValue && r.NewValue > ScoreRank.F)
+                if (r.NewValue != r.OldValue && r.NewValue > ScoreRank.F && PlaySamples.Value)
                 {
                     if (r.NewValue > rankDisplay.Rank)
                         rankUpSample.Play();