From fdb5490e51f1edf5b09aed6ecaf428e7ff03e8a4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bart=C5=82omiej=20Dach?= <dach.bartlomiej@gmail.com>
Date: Fri, 23 Apr 2021 21:56:08 +0200
Subject: [PATCH] Attempt to explain source initialisation better

---
 osu.Game/Screens/Play/GameplayClockContainer.cs | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/osu.Game/Screens/Play/GameplayClockContainer.cs b/osu.Game/Screens/Play/GameplayClockContainer.cs
index 6677116399..6d60c09521 100644
--- a/osu.Game/Screens/Play/GameplayClockContainer.cs
+++ b/osu.Game/Screens/Play/GameplayClockContainer.cs
@@ -63,8 +63,7 @@ namespace osu.Game.Screens.Play
         /// </summary>
         public virtual void Start()
         {
-            // Ensure that the source clock is set.
-            ChangeSource(SourceClock);
+            ensureSourceClockSet();
 
             if (!AdjustableSource.IsRunning)
             {
@@ -100,7 +99,7 @@ namespace osu.Game.Screens.Play
         /// </summary>
         public virtual void Reset()
         {
-            ChangeSource(SourceClock);
+            ensureSourceClockSet();
             Seek(0);
 
             // Manually stop the source in order to not affect the IsPaused state.
@@ -116,6 +115,15 @@ namespace osu.Game.Screens.Play
         /// <param name="sourceClock">The new source.</param>
         protected void ChangeSource(IClock sourceClock) => AdjustableSource.ChangeSource(SourceClock = sourceClock);
 
+        /// <summary>
+        /// Ensures that the <see cref="AdjustableSource"/> is set to <see cref="SourceClock"/>.
+        /// This is usually done before a seek to avoid accidentally seeking only the adjustable source in decoupled mode,
+        /// but not the actual source clock.
+        /// That will pretty much only happen on the very first call of this method, as the source clock is passed in the constructor,
+        /// but it is not yet set on the adjustable source there.
+        /// </summary>
+        private void ensureSourceClockSet() => ChangeSource(SourceClock);
+
         protected override void Update()
         {
             if (!IsPaused.Value)