Merge pull request #6846 from peppy/fix-mod-retention

Fix selected mods not being retained on exiting song select

osu.Game.Tests/Visual/SongSelect/TestScenePlaySongSelect.cs

@@ -242,6 +242,22 @@ namespace osu.Game.Tests.Visual.SongSelect
             void onRulesetChange(ValueChangedEvent<RulesetInfo> e) => rulesetChangeIndex = actionIndex++;
         }
 
+        [Test]
+        public void TestModsRetainedBetweenSongSelect()
+        {
+            AddAssert("empty mods", () => !Mods.Value.Any());
+
+            createSongSelect();
+
+            addRulesetImportStep(0);
+
+            changeMods(new OsuModHardRock());
+
+            createSongSelect();
+
+            AddAssert("mods retained", () => Mods.Value.Any());
+        }
+
         [Test]
         public void TestStartAfterUnMatchingFilterDoesNotStart()
         {

osu.Game/OsuGame.cs

@@ -925,6 +925,8 @@ namespace osu.Game
             {
                 OverlayActivationMode.Value = newOsuScreen.InitialOverlayActivationMode;
 
+                musicController.AllowRateAdjustments = newOsuScreen.AllowRateAdjustments;
+
                 if (newOsuScreen.HideOverlaysOnEnter)
                     CloseAllOverlays();
                 else

osu.Game/Overlays/MusicController.cs

@@ -233,6 +233,24 @@ namespace osu.Game.Overlays
             queuedDirection = null;
         }
 
+        private bool allowRateAdjustments;
+
+        /// <summary>
+        /// Whether mod rate adjustments are allowed to be applied.
+        /// </summary>
+        public bool AllowRateAdjustments
+        {
+            get => allowRateAdjustments;
+            set
+            {
+                if (allowRateAdjustments == value)
+                    return;
+
+                allowRateAdjustments = value;
+                ResetTrackAdjustments();
+            }
+        }
+
         public void ResetTrackAdjustments()
         {
             var track = current?.Track;
@@ -241,8 +259,11 @@ namespace osu.Game.Overlays
 
             track.ResetSpeedAdjustments();
 
-            foreach (var mod in mods.Value.OfType<IApplicableToClock>())
-                mod.ApplyToClock(track);
+            if (allowRateAdjustments)
+            {
+                foreach (var mod in mods.Value.OfType<IApplicableToClock>())
+                    mod.ApplyToClock(track);
+            }
         }
 
         protected override void Dispose(bool isDisposing)

osu.Game/Screens/IOsuScreen.cs

@@ -51,5 +51,10 @@ namespace osu.Game.Screens
         Bindable<WorkingBeatmap> Beatmap { get; }
 
         Bindable<RulesetInfo> Ruleset { get; }
+
+        /// <summary>
+        /// Whether mod rate adjustments are allowed to be applied.
+        /// </summary>
+        bool AllowRateAdjustments { get; }
     }
 }

osu.Game/Screens/Menu/MainMenu.cs

@@ -37,6 +37,8 @@ namespace osu.Game.Screens.Menu
 
         public override bool AllowExternalScreenChange => true;
 
+        public override bool AllowRateAdjustments => false;
+
         private Screen songSelect;
 
         private MenuSideFlashes sideFlashes;

osu.Game/Screens/OsuScreen.cs

@@ -91,6 +91,8 @@ namespace osu.Game.Screens
 
         public Bindable<RulesetInfo> Ruleset { get; private set; }
 
+        public virtual bool AllowRateAdjustments => true;
+
         public Bindable<IReadOnlyList<Mod>> Mods { get; private set; }
 
         protected override IReadOnlyDependencyContainer CreateChildDependencies(IReadOnlyDependencyContainer parent)

osu.Game/Screens/Select/SongSelect.cs

@@ -86,10 +86,6 @@ namespace osu.Game.Screens.Select
         [Resolved(canBeNull: true)]
         private MusicController music { get; set; }
 
-        [Cached]
-        [Cached(Type = typeof(IBindable<IReadOnlyList<Mod>>))]
-        private readonly Bindable<IReadOnlyList<Mod>> mods = new Bindable<IReadOnlyList<Mod>>(Array.Empty<Mod>()); // Bound to the game's mods, but is not reset on exiting
-
         protected SongSelect()
         {
             AddRangeInternal(new Drawable[]
@@ -222,7 +218,7 @@ namespace osu.Game.Screens.Select
         {
             if (Footer != null)
             {
-                Footer.AddButton(new FooterButtonMods { Current = mods }, ModSelect);
+                Footer.AddButton(new FooterButtonMods { Current = Mods }, ModSelect);
                 Footer.AddButton(new FooterButtonRandom { Action = triggerRandom });
                 Footer.AddButton(new FooterButtonOptions(), BeatmapOptions);
 
@@ -262,13 +258,6 @@ namespace osu.Game.Screens.Select
             }
         }
 
-        protected override void LoadComplete()
-        {
-            base.LoadComplete();
-
-            mods.BindTo(Mods);
-        }
-
         private DependencyContainer dependencies;
 
         protected override IReadOnlyDependencyContainer CreateChildDependencies(IReadOnlyDependencyContainer parent)
@@ -390,7 +379,7 @@ namespace osu.Game.Screens.Select
                 {
                     Logger.Log($"ruleset changed from \"{decoupledRuleset.Value}\" to \"{ruleset}\"");
 
-                    mods.Value = Array.Empty<Mod>();
+                    Mods.Value = Array.Empty<Mod>();
                     decoupledRuleset.Value = ruleset;
 
                     // force a filter before attempting to change the beatmap.
@@ -538,9 +527,6 @@ namespace osu.Game.Screens.Select
             if (Beatmap.Value.Track != null)
                 Beatmap.Value.Track.Looping = false;
 
-            mods.UnbindAll();
-            Mods.Value = Array.Empty<Mod>();
-
             return false;
         }
 

osu.Game/Screens/StartupScreen.cs

@@ -16,6 +16,8 @@ namespace osu.Game.Screens
 
         public override bool CursorVisible => false;
 
+        public override bool AllowRateAdjustments => false;
+
         public override OverlayActivation InitialOverlayActivationMode => OverlayActivation.Disabled;
     }
 }