From dc75d55f72af11bdf81b081dad8f5e84be3ed2e2 Mon Sep 17 00:00:00 2001
From: Gabe Livengood <47010459+ggliv@users.noreply.github.com>
Date: Wed, 8 Jun 2022 14:02:15 -0400
Subject: [PATCH] allow modfailcondition to arbitrarily trigger fail

---
 osu.Game/Rulesets/Mods/ModFailCondition.cs   | 19 +++++++++++++++++++
 osu.Game/Rulesets/Scoring/HealthProcessor.cs | 14 ++++++++++----
 2 files changed, 29 insertions(+), 4 deletions(-)

diff --git a/osu.Game/Rulesets/Mods/ModFailCondition.cs b/osu.Game/Rulesets/Mods/ModFailCondition.cs
index 4425ece513..1aab0ab880 100644
--- a/osu.Game/Rulesets/Mods/ModFailCondition.cs
+++ b/osu.Game/Rulesets/Mods/ModFailCondition.cs
@@ -19,12 +19,31 @@ namespace osu.Game.Rulesets.Mods
         public virtual bool PerformFail() => true;
 
         public virtual bool RestartOnFail => Restart.Value;
+        private HealthProcessor healthProcessorInternal;
 
         public void ApplyToHealthProcessor(HealthProcessor healthProcessor)
         {
+            healthProcessorInternal = healthProcessor;
             healthProcessor.FailConditions += FailCondition;
         }
 
+        /// <summary>
+        /// Immediately triggers a failure on the loaded <see cref="HealthProcessor"/>.
+        /// </summary>
+        protected void TriggerArbitraryFailure() => healthProcessorInternal.TriggerFailure();
+
+        /// <summary>
+        /// Determines whether <paramref name="result"/> should trigger a failure. Called every time a
+        /// judgement is applied to <paramref name="healthProcessor"/>.
+        /// </summary>
+        /// <param name="healthProcessor">The loaded <see cref="HealthProcessor"/>.</param>
+        /// <param name="result">The latest <see cref="JudgementResult"/>.</param>
+        /// <returns>Whether the fail condition has been met.</returns>
+        /// <remarks>
+        /// This method should only be used to trigger failures based on <paramref name="result"/>.
+        /// Using outside values to evaluate failure may introduce event ordering discrepancies, use
+        /// an <see cref="IApplicableMod"/> with <see cref="TriggerArbitraryFailure"/> instead.
+        /// </remarks>
         protected abstract bool FailCondition(HealthProcessor healthProcessor, JudgementResult result);
     }
 }
diff --git a/osu.Game/Rulesets/Scoring/HealthProcessor.cs b/osu.Game/Rulesets/Scoring/HealthProcessor.cs
index 0f51560476..4f5ff95477 100644
--- a/osu.Game/Rulesets/Scoring/HealthProcessor.cs
+++ b/osu.Game/Rulesets/Scoring/HealthProcessor.cs
@@ -33,6 +33,15 @@ namespace osu.Game.Rulesets.Scoring
         /// </summary>
         public bool HasFailed { get; private set; }
 
+        /// <summary>
+        /// Immediately triggers a failure for this HealthProcessor.
+        /// </summary>
+        public void TriggerFailure()
+        {
+            if (Failed?.Invoke() != false)
+                HasFailed = true;
+        }
+
         protected override void ApplyResultInternal(JudgementResult result)
         {
             result.HealthAtJudgement = Health.Value;
@@ -44,10 +53,7 @@ namespace osu.Game.Rulesets.Scoring
             Health.Value += GetHealthIncreaseFor(result);
 
             if (meetsAnyFailCondition(result))
-            {
-                if (Failed?.Invoke() != false)
-                    HasFailed = true;
-            }
+                TriggerFailure();
         }
 
         protected override void RevertResultInternal(JudgementResult result)