Fix mouse wheel disable not working during gameplay

osu.Game.Tests/Visual/Navigation/TestSceneMouseWheelVolumeAdjust.cs

@@ -1,8 +1,6 @@
 // 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.
 
-#nullable disable
-
 using NUnit.Framework;
 using osu.Framework.Extensions;
 using osu.Game.Configuration;
@@ -58,7 +56,11 @@ namespace osu.Game.Tests.Visual.Navigation
 
             // First scroll makes volume controls appear, second adjusts volume.
             AddRepeatStep("Adjust volume using mouse wheel", () => InputManager.ScrollVerticalBy(5), 10);
-            AddAssert("Volume is still zero", () => Game.Audio.Volume.Value == 0);
+            AddAssert("Volume is still zero", () => Game.Audio.Volume.Value, () => Is.Zero);
+
+            AddStep("Pause", () => InputManager.PressKey(Key.Escape));
+            AddRepeatStep("Adjust volume using mouse wheel", () => InputManager.ScrollVerticalBy(5), 10);
+            AddAssert("Volume is above zero", () => Game.Audio.Volume.Value > 0);
         }
 
         [Test]
@@ -80,8 +82,8 @@ namespace osu.Game.Tests.Visual.Navigation
 
         private void loadToPlayerNonBreakTime()
         {
-            Player player = null;
-            Screens.Select.SongSelect songSelect = null;
+            Player? player = null;
+            Screens.Select.SongSelect songSelect = null!;
             PushAndConfirm(() => songSelect = new TestSceneScreenNavigation.TestPlaySongSelect());
             AddUntilStep("wait for song select", () => songSelect.BeatmapSetsLoaded);
 
@@ -95,7 +97,7 @@ namespace osu.Game.Tests.Visual.Navigation
                 return (player = Game.ScreenStack.CurrentScreen as Player) != null;
             });
 
-            AddUntilStep("wait for play time active", () => !player.IsBreakTime.Value);
+            AddUntilStep("wait for play time active", () => player!.IsBreakTime.Value, () => Is.False);
         }
     }
 }

osu.Game/Overlays/Volume/GlobalScrollAdjustsVolume.cs

@@ -33,8 +33,5 @@ namespace osu.Game.Overlays.Volume
             // forward any unhandled mouse scroll events to the volume control.
             return volumeOverlay?.Adjust(GlobalAction.IncreaseVolume, e.ScrollDelta.Y, e.IsPrecise) ?? false;
         }
-
-        public bool OnScroll(KeyBindingScrollEvent<GlobalAction> e) =>
-            volumeOverlay?.Adjust(e.Action, e.ScrollAmount, e.IsPrecise) ?? false;
     }
 }

osu.Game/Screens/Play/GameplayScrollWheelHandling.cs

@@ -0,0 +1,44 @@
+// 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 osu.Framework.Allocation;
+using osu.Framework.Bindables;
+using osu.Framework.Input.Events;
+using osu.Game.Configuration;
+using osu.Game.Overlays.Volume;
+
+namespace osu.Game.Screens.Play
+{
+    /// <summary>
+    /// Primarily handles volume adjustment in gameplay.
+    ///
+    /// - If the user has mouse wheel disabled, only allow during break time or when holding alt. Also block scroll from parent handling.
+    /// - Otherwise always allow, as per <see cref="GlobalScrollAdjustsVolume"/> implementation.
+    /// </summary>
+    internal class GameplayScrollWheelHandling : GlobalScrollAdjustsVolume
+    {
+        private Bindable<bool> mouseWheelDisabled = null!;
+
+        [Resolved]
+        private IGameplayClock gameplayClock { get; set; } = null!;
+
+        [BackgroundDependencyLoader]
+        private void load(OsuConfigManager config)
+        {
+            mouseWheelDisabled = config.GetBindable<bool>(OsuSetting.MouseDisableWheel);
+        }
+
+        protected override bool OnScroll(ScrollEvent e)
+        {
+            // During pause, allow global volume adjust regardless of settings.
+            if (gameplayClock.IsPaused.Value)
+                return base.OnScroll(e);
+
+            // Block any parent handling of scroll if the user has asked for it (special case when holding "Alt").
+            if (mouseWheelDisabled.Value && !e.AltPressed)
+                return true;
+
+            return base.OnScroll(e);
+        }
+    }
+}

osu.Game/Screens/Play/Player.cs

@@ -15,7 +15,6 @@ using osu.Framework.Bindables;
 using osu.Framework.Extensions;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
-using osu.Framework.Input.Events;
 using osu.Framework.Logging;
 using osu.Framework.Screens;
 using osu.Framework.Threading;
@@ -28,7 +27,6 @@ using osu.Game.Graphics.Containers;
 using osu.Game.IO.Archives;
 using osu.Game.Online.API;
 using osu.Game.Overlays;
-using osu.Game.Overlays.Volume;
 using osu.Game.Rulesets;
 using osu.Game.Rulesets.Mods;
 using osu.Game.Rulesets.Scoring;
@@ -89,8 +87,6 @@ namespace osu.Game.Screens.Play
         private bool isRestarting;
         private bool skipExitTransition;
 
-        private Bindable<bool> mouseWheelDisabled;
-
         private readonly Bindable<bool> storyboardReplacesBackground = new Bindable<bool>();
 
         public IBindable<bool> LocalUserPlaying => localUserPlaying;
@@ -229,8 +225,6 @@ namespace osu.Game.Screens.Play
                 return;
             }
 
-            mouseWheelDisabled = config.GetBindable<bool>(OsuSetting.MouseDisableWheel);
-
             if (game != null)
                 gameActive.BindTo(game.IsActive);
 
@@ -254,7 +248,6 @@ namespace osu.Game.Screens.Play
 
             InternalChildren = new Drawable[]
             {
-                new GlobalScrollAdjustsVolume(),
                 GameplayClockContainer = CreateGameplayClockContainer(Beatmap.Value, DrawableRuleset.GameplayStartTime),
             };
 
@@ -271,6 +264,7 @@ namespace osu.Game.Screens.Play
             dependencies.CacheAs(GameplayState = new GameplayState(playableBeatmap, ruleset, gameplayMods, Score, ScoreProcessor, HealthProcessor, Beatmap.Value.Storyboard));
 
             var rulesetSkinProvider = new RulesetSkinProvidingContainer(ruleset, playableBeatmap, Beatmap.Value.Skin);
+            GameplayClockContainer.Add(new GameplayScrollWheelHandling());
 
             // load the skinning hierarchy first.
             // this is intentionally done in two stages to ensure things are in a loaded state before exposing the ruleset to skin sources.
@@ -899,16 +893,6 @@ namespace osu.Game.Screens.Play
             });
         }
 
-        protected override bool OnScroll(ScrollEvent e)
-        {
-            // During pause, allow global volume adjust regardless of settings.
-            if (GameplayClockContainer.IsPaused.Value)
-                return false;
-
-            // Block global volume adjust if the user has asked for it (special case when holding "Alt").
-            return mouseWheelDisabled.Value && !e.AltPressed;
-        }
-
         #region Gameplay leaderboard
 
         protected readonly Bindable<bool> LeaderboardExpandedState = new BindableBool();