fix(freeplay): prevent song previews from cutting out when navigating through the menus to quickly

Author: AnimatingLegend

source/funkin/ui/freeplay/FreeplayState.hx

@@ -401,7 +401,6 @@ class FreeplayState extends MusicBeatSubState
         // Set rememberedSongId to last played song if accessed from the RANDOM option
         rememberedSongId = fromResultsParams.songId;
       }
-    
       @:privateAccess
       this._parentState._constructor = () ->
       {
@@ -967,21 +966,11 @@ class FreeplayState extends MusicBeatSubState
     switch (renderType)
     {
       case 'animateatlas':
-        dj = (scriptClass != '') ? (AnimateAtlasFreeplayDJ.scriptInit(
-          scriptClass,
-          x,
-          y,
-          characterId
-        )) : (new AnimateAtlasFreeplayDJ(x, y, characterId));
+        dj = (scriptClass != '') ? (AnimateAtlasFreeplayDJ.scriptInit(scriptClass, x, y, characterId)) : (new AnimateAtlasFreeplayDJ(x, y, characterId));
       case 'sparrow':
         dj = (scriptClass != '') ? (SparrowFreeplayDJ.scriptInit(scriptClass, x, y, characterId)) : (new SparrowFreeplayDJ(x, y, characterId));
       case 'multisparrow':
-        dj = (scriptClass != '') ? (MultiSparrowFreeplayDJ.scriptInit(
-          scriptClass,
-          x,
-          y,
-          characterId
-        )) : (new MultiSparrowFreeplayDJ(x, y, characterId));
+        dj = (scriptClass != '') ? (MultiSparrowFreeplayDJ.scriptInit(scriptClass, x, y, characterId)) : (new MultiSparrowFreeplayDJ(x, y, characterId));
       case 'packer':
         dj = (scriptClass != '') ? (PackerFreeplayDJ.scriptInit(scriptClass, x, y, characterId)) : (new PackerFreeplayDJ(x, y, characterId));
       case 'custom':
@@ -1247,7 +1236,8 @@ class FreeplayState extends MusicBeatSubState
     });
   }
 
-  function rankDisplayNew(fromResults:Null<FromResultsParams>, capsuleToRank:SongMenuItem):Void
+  function rankDisplayNew(fromResults:Null<FromResultsParams>,
+    capsuleToRank:SongMenuItem):Void
   {
     dispatchEvent(new CapsuleScriptEvent(FREEPLAY_RANK_SLAM, currentCapsule, currentDifficulty, currentVariation, fromResults?.newRank));
 
@@ -1397,7 +1387,6 @@ class FreeplayState extends MusicBeatSubState
     new FlxTimer().start(0.5, _ ->
     {
       dispatchEvent(new CapsuleScriptEvent(FREEPLAY_CAPSULE_SLAM, currentCapsule, currentDifficulty, currentVariation, fromResultsParams?.newRank));
-      
       // Capsule slam vibration.
       HapticUtil.vibrate(Constants.DEFAULT_VIBRATION_PERIOD, Constants.DEFAULT_VIBRATION_DURATION, Constants.MAX_VIBRATION_AMPLITUDE);
 
@@ -3257,11 +3246,16 @@ class FreeplayState extends MusicBeatSubState
 
     if (grpCapsules.countLiving() > 0 && !prepForNewRank && uiStateMachine.canInteract())
     {
-      FlxG.sound.music?.pause();
-      FlxTimer.wait(FADE_IN_DELAY, playCurSongPreview.bind(currentCapsule));
-      currentCapsule.selected = true;
+      clearPreviews();
+
+      // Create a timer to delay the song preview to prevent overlapping or cutting out.
+      var previewTransition = new FlxTimer().start(FADE_IN_DELAY, function(_)
+      {
+        if (FlxG.sound.music != null) FlxG.sound.music.stop();
+        playCurSongPreview(currentCapsule);
+      });
 
-      // switchBackingImage(currentCapsule.freeplayData);
+      previewTimers.push(previewTransition);
     }
 
     // Small vibrations every selection change.