Merge pull request #435 from FunkinCrew/feature/freeplay-ost-text

Fix issues with Freeplay OST text and add animations.

assets

@@ -1 +1 @@
-Subproject commit d7e85ef60933ca93d47e1db6295aba8aa64fcbdf
+Subproject commit 346da48a86f07a9c6372bf92c64d68802ae75078

source/funkin/data/freeplay/AlbumData.hx

@@ -1,5 +1,7 @@
 package funkin.data.freeplay;
 
+import funkin.data.animation.AnimationData;
+
 /**
  * A type definition for the data for an album of songs.
  * It includes things like what graphics to display in Freeplay.
@@ -33,4 +35,11 @@ typedef AlbumData =
    * The album title will be displayed below the album art in Freeplay.
    */
   public var albumTitleAsset:String;
+
+  /**
+   * An optional array of animations for the album title.
+   */
+  @:optional
+  @:default([])
+  public var albumTitleAnimations:Array<AnimationData>;
 }

source/funkin/ui/freeplay/Album.hx

@@ -1,6 +1,7 @@
 package funkin.ui.freeplay;
 
 import funkin.data.freeplay.AlbumData;
+import funkin.data.animation.AnimationData;
 import funkin.data.freeplay.AlbumRegistry;
 import funkin.data.IRegistryEntry;
 import flixel.graphics.FlxGraphic;
@@ -75,6 +76,16 @@ class Album implements IRegistryEntry<AlbumData>
     return _data.albumTitleAsset;
   }
 
+  public function hasAlbumTitleAnimations()
+  {
+    return _data.albumTitleAnimations.length > 0;
+  }
+
+  public function getAlbumTitleAnimations():Array<AnimationData>
+  {
+    return _data.albumTitleAnimations;
+  }
+
   public function toString():String
   {
     return 'Album($id)';

source/funkin/ui/freeplay/AlbumRoll.hx

@@ -7,6 +7,7 @@ import flixel.tweens.FlxTween;
 import flixel.util.FlxTimer;
 import flixel.tweens.FlxEase;
 import funkin.data.freeplay.AlbumRegistry;
+import funkin.util.assets.FlxAnimationUtil;
 import funkin.graphics.FunkinSprite;
 import funkin.util.SortUtil;
 import openfl.utils.Assets;
@@ -21,9 +22,9 @@ class AlbumRoll extends FlxSpriteGroup
    * The ID of the album to display.
    * Modify this value to automatically update the album art and title.
    */
-  public var albumId(default, set):String;
+  public var albumId(default, set):Null<String>;
 
-  function set_albumId(value:String):String
+  function set_albumId(value:Null<String>):Null<String>
   {
     if (this.albumId != value)
     {
@@ -65,6 +66,17 @@ class AlbumRoll extends FlxSpriteGroup
    */
   function updateAlbum():Void
   {
+    if (albumId == null)
+    {
+      albumArt.visible = false;
+      albumTitle.visible = false;
+      if (titleTimer != null)
+      {
+        titleTimer.cancel();
+        titleTimer = null;
+      }
+    }
+
     albumData = AlbumRegistry.instance.fetchEntry(albumId);
 
     if (albumData == null)
@@ -94,7 +106,15 @@ class AlbumRoll extends FlxSpriteGroup
 
     if (Assets.exists(Paths.image(albumData.getAlbumTitleAssetKey())))
     {
-      albumTitle.loadGraphic(Paths.image(albumData.getAlbumTitleAssetKey()));
+      if (albumData.hasAlbumTitleAnimations())
+      {
+        albumTitle.loadSparrow(albumData.getAlbumTitleAssetKey());
+        FlxAnimationUtil.addAtlasAnimations(albumTitle, albumData.getAlbumTitleAnimations());
+      }
+      else
+      {
+        albumTitle.loadGraphic(Paths.image(albumData.getAlbumTitleAssetKey()));
+      }
     }
     else
     {
@@ -155,6 +175,8 @@ class AlbumRoll extends FlxSpriteGroup
       });
   }
 
+  var titleTimer:Null<FlxTimer> = null;
+
   /**
    * Play the intro animation on the album art.
    */
@@ -164,7 +186,14 @@ class AlbumRoll extends FlxSpriteGroup
     FlxTween.tween(albumArt, {x: 950, y: 320, angle: -340}, 0.5, {ease: FlxEase.elasticOut});
 
     albumTitle.visible = false;
-    new FlxTimer().start(0.75, function(_) {
+
+    if (titleTimer != null)
+    {
+      titleTimer.cancel();
+      titleTimer = null;
+    }
+
+    titleTimer = new FlxTimer().start(0.75, function(_) {
       showTitle();
     });
   }
@@ -179,6 +208,8 @@ class AlbumRoll extends FlxSpriteGroup
   public function showTitle():Void
   {
     albumTitle.visible = true;
+    albumTitle.animation.play('active');
+    albumTitle.animation.finishCallback = (_) -> albumTitle.animation.play('idle');
   }
 
   /**

source/funkin/ui/freeplay/FreeplayState.hx

@@ -380,7 +380,7 @@ class FreeplayState extends MusicBeatSubState
     }
 
     albumRoll = new AlbumRoll();
-    albumRoll.albumId = 'volume1';
+    albumRoll.albumId = null;
     add(albumRoll);
 
     albumRoll.applyExitMovers(exitMovers);
@@ -906,6 +906,8 @@ class FreeplayState extends MusicBeatSubState
 
         for (spr in grpSpr)
         {
+          if (spr == null) continue;
+
           var funnyMoveShit:MoveData = moveData;
 
           if (moveData.x == null) funnyMoveShit.x = spr.x;
@@ -1044,7 +1046,7 @@ class FreeplayState extends MusicBeatSubState
     albumRoll.setDifficultyStars(daSong?.songRating);
 
     // Set the album graphic and play the animation if relevant.
-    var newAlbumId:String = daSong?.albumId ?? Constants.DEFAULT_ALBUM_ID;
+    var newAlbumId:String = daSong?.albumId;
     if (albumRoll.albumId != newAlbumId)
     {
       albumRoll.albumId = newAlbumId;
@@ -1196,6 +1198,7 @@ class FreeplayState extends MusicBeatSubState
       diffIdsCurrent = diffIdsTotal;
       rememberedSongId = null;
       rememberedDifficulty = null;
+      albumRoll.albumId = null;
     }
 
     for (index => capsule in grpCapsules.members)
@@ -1360,7 +1363,7 @@ class FreeplaySongData
   public var songName(default, null):String = '';
   public var songCharacter(default, null):String = '';
   public var songRating(default, null):Int = 0;
-  public var albumId(default, null):String = '';
+  public var albumId(default, null):Null<String> = null;
 
   public var currentDifficulty(default, set):String = Constants.DEFAULT_DIFFICULTY;
   public var displayedVariations(default, null):Array<String> = [Constants.DEFAULT_VARIATION];
@@ -1394,7 +1397,15 @@ class FreeplaySongData
     this.songName = songDifficulty.songName;
     this.songCharacter = songDifficulty.characters.opponent;
     this.songRating = songDifficulty.difficultyRating;
-    this.albumId = songDifficulty.album;
+    if (songDifficulty.album == null)
+    {
+      FlxG.log.warn('No album for: ${songDifficulty.songName}');
+      this.albumId = Constants.DEFAULT_ALBUM_ID;
+    }
+    else
+    {
+      this.albumId = songDifficulty.album;
+    }
   }
 }