Merge pull request #9007 from peppy/fix-failure-logic

Fix mod failure checks executing actual game logic

osu.Game.Rulesets.Osu/Mods/OsuModAutopilot.cs

@@ -24,7 +24,8 @@ namespace osu.Game.Rulesets.Osu.Mods
         public override double ScoreMultiplier => 1;
         public override Type[] IncompatibleMods => new[] { typeof(OsuModSpunOut), typeof(ModRelax), typeof(ModSuddenDeath), typeof(ModNoFail), typeof(ModAutoplay) };
 
-        public bool AllowFail => false;
+        public bool PerformFail() => false;
+
         public bool RestartOnFail => false;
 
         private OsuInputManager inputManager;

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

@@ -33,7 +33,8 @@ namespace osu.Game.Tests.Visual.Gameplay
         {
             public new ScoreProcessor ScoreProcessor => base.ScoreProcessor;
             public new HUDOverlay HUDOverlay => base.HUDOverlay;
-            public new bool AllowFail => base.AllowFail;
+
+            public bool AllowFail => base.CheckModsAllowFailure();
 
             protected override bool PauseOnFocusLost => false;
 

osu.Game/Rulesets/Mods/IApplicableFailOverride.cs

@@ -11,10 +11,11 @@ namespace osu.Game.Rulesets.Mods
         /// <summary>
         /// Whether we should allow failing at the current point in time.
         /// </summary>
-        bool AllowFail { get; }
+        /// <returns>Whether the fail should be allowed to proceed. Return false to block.</returns>
+        bool PerformFail();
 
         /// <summary>
-        /// Whether we want to restart on fail. Only used if <see cref="AllowFail"/> is true.
+        /// Whether we want to restart on fail. Only used if <see cref="PerformFail"/> returns true.
         /// </summary>
         bool RestartOnFail { get; }
     }

osu.Game/Rulesets/Mods/ModAutoplay.cs

@@ -27,7 +27,8 @@ namespace osu.Game.Rulesets.Mods
         public override string Description => "Watch a perfect automated play through the song.";
         public override double ScoreMultiplier => 1;
 
-        public bool AllowFail => false;
+        public bool PerformFail() => false;
+
         public bool RestartOnFail => false;
 
         public override Type[] IncompatibleMods => new[] { typeof(ModRelax), typeof(ModSuddenDeath), typeof(ModNoFail) };

osu.Game/Rulesets/Mods/ModBlockFail.cs

@@ -14,7 +14,7 @@ namespace osu.Game.Rulesets.Mods
         /// <summary>
         /// We never fail, 'yo.
         /// </summary>
-        public bool AllowFail => false;
+        public bool PerformFail() => false;
 
         public bool RestartOnFail => false;
 

osu.Game/Rulesets/Mods/ModEasy.cs

@@ -48,17 +48,14 @@ namespace osu.Game.Rulesets.Mods
             retries = Retries.Value;
         }
 
-        public bool AllowFail
+        public bool PerformFail()
         {
-            get
-            {
-                if (retries == 0) return true;
+            if (retries == 0) return true;
 
-                health.Value = health.MaxValue;
-                retries--;
+            health.Value = health.MaxValue;
+            retries--;
 
-                return false;
-            }
+            return false;
         }
 
         public bool RestartOnFail => false;

osu.Game/Rulesets/Mods/ModSuddenDeath.cs

@@ -20,7 +20,8 @@ namespace osu.Game.Rulesets.Mods
         public override bool Ranked => true;
         public override Type[] IncompatibleMods => new[] { typeof(ModNoFail), typeof(ModRelax), typeof(ModAutoplay) };
 
-        public bool AllowFail => true;
+        public bool PerformFail() => true;
+
         public bool RestartOnFail => true;
 
         public void ApplyToHealthProcessor(HealthProcessor healthProcessor)

osu.Game/Screens/Play/Player.cs

@@ -105,7 +105,7 @@ namespace osu.Game.Screens.Play
         /// Whether failing should be allowed.
         /// By default, this checks whether all selected mods allow failing.
         /// </summary>
-        protected virtual bool AllowFail => Mods.Value.OfType<IApplicableFailOverride>().All(m => m.AllowFail);
+        protected virtual bool CheckModsAllowFailure() => Mods.Value.OfType<IApplicableFailOverride>().All(m => m.PerformFail());
 
         private readonly bool allowPause;
         private readonly bool showResults;
@@ -485,7 +485,7 @@ namespace osu.Game.Screens.Play
 
         private bool onFail()
         {
-            if (!AllowFail)
+            if (!CheckModsAllowFailure())
                 return false;
 
             HasFailed = true;

osu.Game/Screens/Play/ReplayPlayer.cs

@@ -12,7 +12,7 @@ namespace osu.Game.Screens.Play
         private readonly Score score;
 
         // Disallow replays from failing. (see https://github.com/ppy/osu/issues/6108)
-        protected override bool AllowFail => false;
+        protected override bool CheckModsAllowFailure() => false;
 
         public ReplayPlayer(Score score, bool allowPause = true, bool showResults = true)
             : base(allowPause, showResults)

osu.Game/Tests/Visual/ModPerfectTestScene.cs

@@ -41,7 +41,7 @@ namespace osu.Game.Tests.Visual
             {
             }
 
-            protected override bool AllowFail => true;
+            protected override bool CheckModsAllowFailure() => true;
 
             public bool CheckFailed(bool failed)
             {

osu.Game/Tests/Visual/ModTestScene.cs

@@ -64,12 +64,14 @@ namespace osu.Game.Tests.Visual
 
         protected class ModTestPlayer : TestPlayer
         {
-            protected override bool AllowFail { get; }
+            private readonly bool allowFail;
+
+            protected override bool CheckModsAllowFailure() => allowFail;
 
             public ModTestPlayer(bool allowFail)
                 : base(false, false)
             {
-                AllowFail = allowFail;
+                this.allowFail = allowFail;
             }
         }