Merge pull request #29 from winnerspiros/catch-variable-clockrates-11639420423937482729

Support variable clockrates in Catch difficulty calculation

Author: winnerspiros

osu.Game.Rulesets.Catch/Difficulty/CatchDifficultyCalculator.cs

@@ -52,6 +52,9 @@ protected override IEnumerable<DifficultyHitObject> CreateDifficultyHitObjects(I
 
             List<DifficultyHitObject> objects = new List<DifficultyHitObject>();
 
+            // Get applicable rate mods upfront to avoid iterating and filtering Mods for every object.
+            var rateMods = Mods.OfType<IApplicableToRate>().ToList();
+
             // In 2B beatmaps, it is possible that a normal Fruit is placed in the middle of a JuiceStream.
             foreach (var hitObject in CatchBeatmap.GetPalpableObjects(beatmap.HitObjects))
             {
@@ -60,7 +63,14 @@ protected override IEnumerable<DifficultyHitObject> CreateDifficultyHitObjects(I
                     continue;
 
                 if (lastObject != null)
-                    objects.Add(new CatchDifficultyHitObject(hitObject, lastObject, clockRate, halfCatcherWidth, objects, objects.Count));
+                {
+                    double objectClockRate = 1;
+
+                    foreach (var mod in rateMods)
+                        objectClockRate = mod.ApplyToRate(hitObject.StartTime, objectClockRate);
+
+                    objects.Add(new CatchDifficultyHitObject(hitObject, lastObject, objectClockRate, halfCatcherWidth, objects, objects.Count));
+                }
 
                 lastObject = hitObject;
             }
@@ -77,7 +87,7 @@ protected override Skill[] CreateSkills(IBeatmap beatmap, Mod[] mods, double clo
 
             return new Skill[]
             {
-                new Movement(mods, halfCatcherWidth, clockRate),
+                new Movement(mods, halfCatcherWidth),
             };
         }
 

osu.Game.Rulesets.Catch/Difficulty/Preprocessing/CatchDifficultyHitObject.cs

@@ -59,9 +59,13 @@ public class CatchDifficultyHitObject : DifficultyHitObject
         /// </summary>
         public readonly double StrainTime;
 
-        public CatchDifficultyHitObject(HitObject hitObject, HitObject lastObject, double clockRate, float halfCatcherWidth, List<DifficultyHitObject> objects, int index)
-            : base(hitObject, lastObject, clockRate, objects, index)
+        public readonly double CatcherSpeedMultiplier;
+
+        public CatchDifficultyHitObject(HitObject hitObject, HitObject lastObject, double catcherSpeedMultiplier, float halfCatcherWidth, List<DifficultyHitObject> objects, int index)
+            : base(hitObject, lastObject, catcherSpeedMultiplier, objects, index)
         {
+            CatcherSpeedMultiplier = catcherSpeedMultiplier;
+
             // We will scale everything by this factor, so we can assume a uniform CircleSize among beatmaps.
             float scalingFactor = NORMALIZED_HALF_CATCHER_WIDTH / halfCatcherWidth;
 

osu.Game.Rulesets.Catch/Difficulty/Skills/Movement.cs

@@ -2,6 +2,7 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using osu.Game.Rulesets.Catch.Difficulty.Evaluators;
+using osu.Game.Rulesets.Catch.Difficulty.Preprocessing;
 using osu.Game.Rulesets.Difficulty.Preprocessing;
 using osu.Game.Rulesets.Difficulty.Skills;
 using osu.Game.Rulesets.Mods;
@@ -19,26 +20,15 @@ public class Movement : StrainDecaySkill
 
         protected readonly float HalfCatcherWidth;
 
-        /// <summary>
-        /// The speed multiplier applied to the player's catcher.
-        /// </summary>
-        private readonly double catcherSpeedMultiplier;
-
-        public Movement(Mod[] mods, float halfCatcherWidth, double clockRate)
+        public Movement(Mod[] mods, float halfCatcherWidth)
             : base(mods)
         {
             HalfCatcherWidth = halfCatcherWidth;
-
-            // In catch, clockrate adjustments do not only affect the timings of hitobjects,
-            // but also the speed of the player's catcher, which has an impact on difficulty
-            // TODO: Support variable clockrates caused by mods such as ModTimeRamp
-            //  (perhaps by using IApplicableToRate within the CatchDifficultyHitObject constructor to set a catcher speed for each object before processing)
-            catcherSpeedMultiplier = clockRate;
         }
 
         protected override double StrainValueOf(DifficultyHitObject current)
         {
-            return MovementEvaluator.EvaluateDifficultyOf(current, catcherSpeedMultiplier);
+            return MovementEvaluator.EvaluateDifficultyOf(current, ((CatchDifficultyHitObject)current).CatcherSpeedMultiplier);
         }
     }
 }

osu.Game.Tests/Visual/Multiplayer/TestSceneMultiplayerMatchSubScreen.cs

@@ -73,7 +73,28 @@ public override void SetUpSteps()
         {
             base.SetUpSteps();
 
-            AddUntilStep("wait for mod select removed", () => this.ChildrenOfType<MultiplayerUserModSelectOverlay>().Count(), () => Is.Zero);
+            AddUntilStep("wait for mod select removed", () =>
+            {
+                if (this.ChildrenOfType<MultiplayerUserModSelectOverlay>().Any())
+                {
+                    // This overlay is a bit problematic as it can be present even if the screen that created it has exited.
+                    // If it is present, force close it.
+                    var modSelect = this.ChildrenOfType<MultiplayerUserModSelectOverlay>().First();
+                    modSelect.Hide();
+                    // If it's still visible after hide request (e.g. animation), we still wait.
+                    // But checking Count() implies checking presence in hierarchy or visual state?
+                    // ChildrenOfType checks hierarchy. If Hide() starts fade out, it might still be there.
+                    // But if hierarchy removal is tied to state, we might need to wait more.
+                    // However, base.SetUpSteps() calls ExitAllScreens.
+                    // If the screen is gone, the overlay should be gone unless it's attached to global overlay content?
+                    // MultiplayerMatchSubScreen uses IOverlayManager.RegisterBlockingOverlay. This attaches it to the overlay content.
+                    // So we must ensure it is Unregistered/Hidden.
+                    // MultiplayerMatchSubScreen.OnLeaving hides it.
+                    // If OnLeaving wasn't called, it stays.
+                    return false;
+                }
+                return true;
+            });
 
             AddStep("load match", () =>
             {

osu.Game/Rulesets/Difficulty/DifficultyCalculator.cs

@@ -33,6 +33,8 @@ public abstract class DifficultyCalculator
         /// </summary>
         protected readonly IWorkingBeatmap WorkingBeatmap;
 
+        protected IReadOnlyList<Mod> Mods => playableMods ?? Array.Empty<Mod>();
+
         private Mod[] playableMods;
         private double clockRate;