Merge pull request #4539 from peppy/better-player-flags

Remove read/write player flags

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

@@ -297,11 +297,6 @@ namespace osu.Game.Rulesets.Osu.Tests
 
         private void performTest(List<ReplayFrame> frames)
         {
-            // Empty frame to be added as a workaround for first frame behavior.
-            // If an input exists on the first frame, the input would apply to the entire intro lead-in
-            // Likely requires some discussion regarding how first frame inputs should be handled.
-            frames.Insert(0, new OsuReplayFrame());
-
             AddStep("load player", () =>
             {
                 Beatmap.Value = new TestWorkingBeatmap(new Beatmap<OsuHitObject>
@@ -330,12 +325,7 @@ namespace osu.Game.Rulesets.Osu.Tests
                     },
                 }, Clock);
 
-                var p = new ScoreAccessibleReplayPlayer(new Score { Replay = new Replay { Frames = frames } })
-                {
-                    AllowPause = false,
-                    AllowLeadIn = false,
-                    AllowResults = false
-                };
+                var p = new ScoreAccessibleReplayPlayer(new Score { Replay = new Replay { Frames = frames } });
 
                 p.OnLoadComplete += _ =>
                 {
@@ -364,7 +354,7 @@ namespace osu.Game.Rulesets.Osu.Tests
             public new ScoreProcessor ScoreProcessor => base.ScoreProcessor;
 
             public ScoreAccessibleReplayPlayer(Score score)
-                : base(score)
+                : base(score, false, false)
             {
             }
         }

osu.Game.Tests/Visual/Background/TestCaseBackgroundScreenBeatmap.cs

@@ -255,7 +255,8 @@ namespace osu.Game.Tests.Visual.Background
         {
             setupUserSettings();
 
-            AddStep("Start player loader", () => songSelect.Push(playerLoader = new TestPlayerLoader(player = new TestPlayer { AllowPause = allowPause, })));
+            AddStep("Start player loader", () => songSelect.Push(playerLoader = new TestPlayerLoader(player = new TestPlayer(allowPause))));
+
             AddUntilStep("Wait for Player Loader to load", () => playerLoader.IsLoaded);
             AddStep("Move mouse to center of screen", () => InputManager.MoveMouseTo(playerLoader.ScreenPos));
             AddUntilStep("Wait for player to load", () => player.IsLoaded);
@@ -350,6 +351,11 @@ namespace osu.Game.Tests.Visual.Background
             public readonly Bindable<bool> ReplacesBackground = new Bindable<bool>();
             public readonly Bindable<bool> IsPaused = new Bindable<bool>();
 
+            public TestPlayer(bool allowPause = true)
+                : base(allowPause)
+            {
+            }
+
             public bool IsStoryboardVisible() => ((TestUserDimContainer)CurrentStoryboardContainer).CurrentAlpha == 1;
 
             public bool IsStoryboardInvisible() => ((TestUserDimContainer)CurrentStoryboardContainer).CurrentAlpha <= 1;

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

@@ -15,12 +15,7 @@ namespace osu.Game.Tests.Visual.Gameplay
         protected override Player CreatePlayer(Ruleset ruleset)
         {
             Beatmap.Value.Mods.Value = Beatmap.Value.Mods.Value.Concat(new[] { ruleset.GetAutoplayMod() });
-            return new ScoreAccessiblePlayer
-            {
-                AllowPause = false,
-                AllowLeadIn = false,
-                AllowResults = false,
-            };
+            return new ScoreAccessiblePlayer();
         }
 
         protected override void AddCheckSteps()
@@ -33,6 +28,11 @@ namespace osu.Game.Tests.Visual.Gameplay
         {
             public new ScoreProcessor ScoreProcessor => base.ScoreProcessor;
             public new HUDOverlay HUDOverlay => base.HUDOverlay;
+
+            public ScoreAccessiblePlayer()
+                : base(false, false)
+            {
+            }
         }
     }
 }

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

@@ -26,12 +26,7 @@ namespace osu.Game.Tests.Visual.Gameplay
         {
             Beatmap.Value = new DummyWorkingBeatmap(game);
 
-            AddStep("load dummy beatmap", () => stack.Push(loader = new PlayerLoader(() => new Player
-            {
-                AllowPause = false,
-                AllowLeadIn = false,
-                AllowResults = false,
-            })));
+            AddStep("load dummy beatmap", () => stack.Push(loader = new PlayerLoader(() => new Player(false, false))));
 
             AddUntilStep("wait for current", () => loader.IsCurrentScreen());
 
@@ -47,12 +42,7 @@ namespace osu.Game.Tests.Visual.Gameplay
             {
                 SlowLoadPlayer slow = null;
 
-                stack.Push(loader = new PlayerLoader(() => slow = new SlowLoadPlayer
-                {
-                    AllowPause = false,
-                    AllowLeadIn = false,
-                    AllowResults = false,
-                }));
+                stack.Push(loader = new PlayerLoader(() => slow = new SlowLoadPlayer(false, false)));
 
                 Scheduler.AddDelayed(() => slow.Ready = true, 5000);
             });
@@ -64,6 +54,11 @@ namespace osu.Game.Tests.Visual.Gameplay
         {
             public bool Ready;
 
+            public SlowLoadPlayer(bool allowPause = true, bool showResults = true)
+                : base(allowPause, showResults)
+            {
+            }
+
             [BackgroundDependencyLoader]
             private void load()
             {

osu.Game/Screens/Play/GameplayClockContainer.cs

@@ -54,7 +54,7 @@ namespace osu.Game.Screens.Play
 
         private readonly FramedOffsetClock offsetClock;
 
-        public GameplayClockContainer(WorkingBeatmap beatmap, bool allowLeadIn, double gameplayStartTime)
+        public GameplayClockContainer(WorkingBeatmap beatmap, double gameplayStartTime)
         {
             this.beatmap = beatmap;
 
@@ -64,9 +64,7 @@ namespace osu.Game.Screens.Play
 
             adjustableClock = new DecoupleableInterpolatingFramedClock { IsCoupled = false };
 
-            adjustableClock.Seek(allowLeadIn
-                ? Math.Min(0, gameplayStartTime - beatmap.BeatmapInfo.AudioLeadIn)
-                : gameplayStartTime);
+            adjustableClock.Seek(Math.Min(0, gameplayStartTime - beatmap.BeatmapInfo.AudioLeadIn));
 
             adjustableClock.ProcessFrame();
 

osu.Game/Screens/Play/Player.cs

@@ -43,10 +43,6 @@ namespace osu.Game.Screens.Play
 
         public bool HasFailed { get; private set; }
 
-        public bool AllowPause { get; set; } = true;
-        public bool AllowLeadIn { get; set; } = true;
-        public bool AllowResults { get; set; } = true;
-
         private Bindable<bool> mouseWheelDisabled;
 
         private readonly Bindable<bool> storyboardReplacesBackground = new Bindable<bool>();
@@ -71,6 +67,20 @@ namespace osu.Game.Screens.Play
 
         protected GameplayClockContainer GameplayClockContainer { get; private set; }
 
+        private readonly bool allowPause;
+        private readonly bool showResults;
+
+        /// <summary>
+        /// Create a new player instance.
+        /// </summary>
+        /// <param name="allowPause">Whether pausing should be allowed. If not allowed, attempting to pause will quit.</param>
+        /// <param name="showResults">Whether results screen should be pushed on completion.</param>
+        public Player(bool allowPause = true, bool showResults = true)
+        {
+            this.allowPause = allowPause;
+            this.showResults = showResults;
+        }
+
         [BackgroundDependencyLoader]
         private void load(AudioManager audio, IAPIProvider api, OsuConfigManager config)
         {
@@ -90,7 +100,7 @@ namespace osu.Game.Screens.Play
             if (!ScoreProcessor.Mode.Disabled)
                 config.BindWith(OsuSetting.ScoreDisplayMode, ScoreProcessor.Mode);
 
-            InternalChild = GameplayClockContainer = new GameplayClockContainer(working, AllowLeadIn, DrawableRuleset.GameplayStartTime);
+            InternalChild = GameplayClockContainer = new GameplayClockContainer(working, DrawableRuleset.GameplayStartTime);
 
             GameplayClockContainer.Children = new[]
             {
@@ -234,7 +244,7 @@ namespace osu.Game.Screens.Play
 
             ValidForResume = false;
 
-            if (!AllowResults) return;
+            if (!showResults) return;
 
             using (BeginDelayedSequence(1000))
             {
@@ -348,7 +358,7 @@ namespace osu.Game.Screens.Play
 
         private bool canPause =>
             // must pass basic screen conditions (beatmap loaded, instance allows pause)
-            LoadedBeatmapSuccessfully && AllowPause && ValidForResume
+            LoadedBeatmapSuccessfully && allowPause && ValidForResume
             // replays cannot be paused and exit immediately
             && !DrawableRuleset.HasReplayLoaded.Value
             // cannot pause if we are already in a fail state

osu.Game/Screens/Play/ReplayPlayer.cs

@@ -9,7 +9,8 @@ namespace osu.Game.Screens.Play
     {
         private readonly Score score;
 
-        public ReplayPlayer(Score score)
+        public ReplayPlayer(Score score, bool allowPause = true, bool showResults = true)
+            : base(allowPause, showResults)
         {
             this.score = score;
         }

osu.Game/Tests/Visual/AllPlayersTestCase.cs

@@ -80,11 +80,6 @@ namespace osu.Game.Tests.Visual
             return Player;
         }
 
-        protected virtual Player CreatePlayer(Ruleset ruleset) => new Player
-        {
-            AllowPause = false,
-            AllowLeadIn = false,
-            AllowResults = false,
-        };
+        protected virtual Player CreatePlayer(Ruleset ruleset) => new Player(false, false);
     }
 }

osu.Game/Tests/Visual/PlayerTestCase.cs

@@ -61,11 +61,6 @@ namespace osu.Game.Tests.Visual
             LoadScreen(Player);
         }
 
-        protected virtual Player CreatePlayer(Ruleset ruleset) => new Player
-        {
-            AllowPause = false,
-            AllowLeadIn = false,
-            AllowResults = false,
-        };
+        protected virtual Player CreatePlayer(Ruleset ruleset) => new Player(false, false);
     }
 }