From e1e12f41e94c2fe7909048867ca217a414bbae51 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Fri, 7 Oct 2022 21:00:02 +0900
Subject: [PATCH] Add more comprehensive inline comment

---
 osu.Game.Rulesets.Mania/UI/Column.cs | 25 ++++++++++++++++++-------
 1 file changed, 18 insertions(+), 7 deletions(-)

diff --git a/osu.Game.Rulesets.Mania/UI/Column.cs b/osu.Game.Rulesets.Mania/UI/Column.cs
index be26c41ceb..3d46bdaa7b 100644
--- a/osu.Game.Rulesets.Mania/UI/Column.cs
+++ b/osu.Game.Rulesets.Mania/UI/Column.cs
@@ -71,15 +71,14 @@ public Column(int index, bool isSpecial)
         [BackgroundDependencyLoader]
         private void load(GameHost host)
         {
+            SkinnableDrawable keyArea;
+
             skin.SourceChanged += onSourceChanged;
             onSourceChanged();
 
             Drawable background = new SkinnableDrawable(new ManiaSkinComponent(ManiaSkinComponents.ColumnBackground), _ => new DefaultColumnBackground())
             {
                 RelativeSizeAxes = Axes.Both,
-                // This is pretty dodgy (and will cause weirdness when pausing gameplay) but is better than completely broken rewind.
-                Clock = host.UpdateThread.Clock,
-                ProcessCustomClock = false,
             };
 
             InternalChildren = new[]
@@ -89,18 +88,18 @@ private void load(GameHost host)
                 // For input purposes, the background is added at the highest depth, but is then proxied back below all other elements
                 background.CreateProxy(),
                 HitObjectArea,
-                new SkinnableDrawable(new ManiaSkinComponent(ManiaSkinComponents.KeyArea), _ => new DefaultKeyArea())
+                keyArea = new SkinnableDrawable(new ManiaSkinComponent(ManiaSkinComponents.KeyArea), _ => new DefaultKeyArea())
                 {
                     RelativeSizeAxes = Axes.Both,
-                    // This is pretty dodgy (and will cause weirdness when pausing gameplay) but is better than completely broken rewind.
-                    Clock = host.UpdateThread.Clock,
-                    ProcessCustomClock = false,
                 },
                 background,
                 TopLevelContainer,
                 new ColumnTouchInputArea(this)
             };
 
+            applyGameWideClock(background);
+            applyGameWideClock(keyArea);
+
             TopLevelContainer.Add(HitObjectArea.Explosions.CreateProxy());
 
             RegisterPool<Note, DrawableNote>(10, 50);
@@ -108,6 +107,18 @@ private void load(GameHost host)
             RegisterPool<HeadNote, DrawableHoldNoteHead>(10, 50);
             RegisterPool<TailNote, DrawableHoldNoteTail>(10, 50);
             RegisterPool<HoldNoteTick, DrawableHoldNoteTick>(50, 250);
+
+            // Some elements don't handle rewind correctly and fixing them is non-trivial.
+            // In the future we need a better solution to this, but as a temporary work-around, give these components the game-wide
+            // clock so they don't need to worry about rewind.
+            // This only works because they handle OnPressed/OnReleased which results in a correct state while rewinding.
+            //
+            // This is kinda dodgy (and will cause weirdness when pausing gameplay) but is better than completely broken rewind.
+            void applyGameWideClock(Drawable drawable)
+            {
+                drawable.Clock = host.UpdateThread.Clock;
+                drawable.ProcessCustomClock = false;
+            }
         }
 
         private void onSourceChanged()