Replace FlxAnimate with flixel-animate

Co-authored-by: Hyper_ <40342021+NotHyper-474@users.noreply.github.com>
Co-authored-by: MaybeMaru <97055307+MaybeMaru@users.noreply.github.com>
Co-authored-by: Trayfellow <48515908+trayfellow@users.noreply.github.com>

Author: 4 people

assets

@@ -56,11 +56,11 @@
       "url": "https://github.com/FunkinCrew/flixel-addons"
     },
     {
-      "name": "flxanimate",
+      "name": "flixel-animate",
       "type": "git",
       "dir": null,
-      "ref": "49214278b9124823582cdcecd94f4a1de9a4b36b",
-      "url": "https://github.com/FunkinCrew/flxanimate"
+      "ref": "1ed39626306b3cfb75df40890295069d1cd02698",
+      "url": "https://github.com/MaybeMaru/flixel-animate"
     },
     {
       "name": "format",

hmm.json

@@ -1292,7 +1292,7 @@ class Project extends HXProject
     }
 
     addHaxelib('polymod'); // Modding framework
-    addHaxelib('flxanimate'); // Texture atlas rendering
+    addHaxelib('flixel-animate'); // Texture atlas rendering
 
     addHaxelib('json2object'); // JSON parsing
     addHaxelib('jsonpath'); // JSON parsing

project.hxp

@@ -1,13 +1,14 @@
 package funkin;
 
 import openfl.utils.Future;
+import funkin.util.macro.ConsoleMacro;
 
 /**
  * A wrapper around `openfl.utils.Assets` which disallows access to the harmful functions.
  * Later we'll add Funkin-specific caching to this.
  */
 @:nullSafety
-class Assets
+class Assets implements ConsoleClass
 {
   /**
    * The assets cache.

source/funkin/Assets.hx

@@ -111,6 +111,16 @@ class FunkinMemory
 
   ///// TEXTURES /////
 
+  /**
+   * Determine whether the texture with the given key is cached.
+   * @param key The key of the texture to check.
+   * @return Whether the texture is cached.
+   */
+  public static function isTextureCached(key:String):Bool
+  {
+    return FlxG.bitmap.get(key) != null;
+  }
+
   /**
    * Ensures a texture with the given key is cached.
    * @param key The key of the texture to cache.

source/funkin/FunkinMemory.hx

@@ -2,13 +2,14 @@ package funkin;
 
 import flixel.graphics.frames.FlxAtlasFrames;
 import openfl.utils.AssetType;
+import funkin.util.macro.ConsoleMacro;
 import haxe.io.Path;
 
 /**
  * A core class which handles determining asset paths.
  */
 @:nullSafety
-class Paths
+class Paths implements ConsoleClass
 {
   static var currentLevel:Null<String> = null;
 

source/funkin/Paths.hx

@@ -83,7 +83,7 @@ typedef UnnamedAnimationData =
 
   /**
    * Optionally specify an asset path to use for this specific animation.
-   * ONLY for use by MultiSparrow characters.
+   * ONLY for use by MultiSparrow and MultiAnimateAtlas characters.
    * @default The assetPath of the parent sprite
    */
   @:optional
@@ -138,4 +138,13 @@ typedef UnnamedAnimationData =
   @:default([])
   @:optional
   var frameIndices:Null<Array<Int>>;
+
+  /**
+   * The type of animation to use.
+   * Only available for texture atlases.
+   * Options: "framelabel", "symbol"
+   */
+  @:default("framelabel")
+  @:optional
+  var animType:String;
 }

source/funkin/data/animation/AnimationData.hx

@@ -6,12 +6,14 @@ import funkin.modding.events.ScriptEventDispatcher;
 import funkin.play.character.ScriptedCharacter.ScriptedAnimateAtlasCharacter;
 import funkin.play.character.ScriptedCharacter.ScriptedBaseCharacter;
 import funkin.play.character.ScriptedCharacter.ScriptedMultiSparrowCharacter;
+import funkin.play.character.ScriptedCharacter.ScriptedMultiAnimateAtlasCharacter;
 import funkin.play.character.ScriptedCharacter.ScriptedPackerCharacter;
 import funkin.play.character.ScriptedCharacter.ScriptedSparrowCharacter;
 import funkin.play.character.AnimateAtlasCharacter;
 import funkin.play.character.BaseCharacter;
 import funkin.play.character.SparrowCharacter;
 import funkin.play.character.MultiSparrowCharacter;
+import funkin.play.character.MultiAnimateAtlasCharacter;
 import funkin.play.character.PackerCharacter;
 import funkin.util.assets.DataAssets;
 import funkin.util.VersionUtil;
@@ -160,14 +162,34 @@ class CharacterDataParser
       }
     }
 
+    var scriptedCharClassNames5:Array<String> = ScriptedMultiAnimateAtlasCharacter.listScriptClasses();
+    if (scriptedCharClassNames5.length > 0)
+    {
+      trace('  Instantiating ${scriptedCharClassNames5.length} (Multi-Animate Atlas) scripted characters...');
+      for (charCls in scriptedCharClassNames5)
+      {
+        try
+        {
+          var character:MultiAnimateAtlasCharacter = ScriptedMultiAnimateAtlasCharacter.init(charCls, DEFAULT_CHAR_ID);
+          characterScriptedClass.set(character.characterId, charCls);
+        }
+        catch (e)
+        {
+          trace('    FAILED to instantiate scripted Multi-Animate Atlas character: ${charCls}');
+          trace(e);
+        }
+      }
+    }
+
     // NOTE: Only instantiate the ones not populated above.
     // ScriptedBaseCharacter.listScriptClasses() will pick up scripts extending the other classes.
     var scriptedCharClassNames:Array<String> = ScriptedBaseCharacter.listScriptClasses();
     scriptedCharClassNames = scriptedCharClassNames.filter(function(charCls:String):Bool {
       return !(scriptedCharClassNames1.contains(charCls)
         || scriptedCharClassNames2.contains(charCls)
         || scriptedCharClassNames3.contains(charCls)
-        || scriptedCharClassNames4.contains(charCls));
+        || scriptedCharClassNames4.contains(charCls)
+        || scriptedCharClassNames5.contains(charCls));
     });
 
     if (scriptedCharClassNames.length > 0)
@@ -226,6 +248,8 @@ class CharacterDataParser
           char = ScriptedSparrowCharacter.init(charScriptClass, charId);
         case CharacterRenderType.Packer:
           char = ScriptedPackerCharacter.init(charScriptClass, charId);
+        case CharacterRenderType.MultiAnimateAtlas:
+          char = ScriptedMultiAnimateAtlasCharacter.init(charScriptClass, charId);
         default:
           // We're going to assume that the script class does the rendering.
           char = ScriptedBaseCharacter.init(charScriptClass, charId, CharacterRenderType.Custom);
@@ -243,6 +267,8 @@ class CharacterDataParser
           char = new SparrowCharacter(charId);
         case CharacterRenderType.Packer:
           char = new PackerCharacter(charId);
+        case CharacterRenderType.MultiAnimateAtlas:
+          char = new MultiAnimateAtlasCharacter(charId);
         default:
           trace('[WARN] Creating character with undefined renderType ${charData.renderType}');
           char = new BaseCharacter(charId, CharacterRenderType.Custom);
@@ -431,6 +457,15 @@ class CharacterDataParser
   public static final DEFAULT_SCALE:Float = 1;
   public static final DEFAULT_SCROLL:Array<Float> = [0, 0];
   public static final DEFAULT_STARTINGANIM:String = 'idle';
+  public static final DEFAULT_APPLYSTAGEMATRIX:Bool = false;
+  public static final DEFAULT_ANIMTYPE:String = "framelabel";
+  public static final DEFAULT_ATLASSETTINGS:funkin.data.stage.StageData.TextureAtlasData =
+    {
+      swfMode: true,
+      cacheOnLoad: false,
+      filterQuality: 1,
+      applyStageMatrix: false
+    };
 
   /**
    * Set unspecified parameters to their defaults.
@@ -559,6 +594,16 @@ class CharacterDataParser
       input.flipX = DEFAULT_FLIPX;
     }
 
+    if (input.applyStageMatrix == null)
+    {
+      input.applyStageMatrix = DEFAULT_APPLYSTAGEMATRIX;
+    }
+
+    if (input.atlasSettings == null)
+    {
+      input.atlasSettings = DEFAULT_ATLASSETTINGS;
+    }
+
     if (input.animations.length == 0 && input.startingAnimation != null)
     {
       return null;
@@ -596,6 +641,11 @@ class CharacterDataParser
       {
         inputAnimation.flipY = DEFAULT_FLIPY;
       }
+
+      if (inputAnimation.animType == null)
+      {
+        inputAnimation.animType = DEFAULT_ANIMTYPE;
+      }
     }
 
     // All good!
@@ -624,10 +674,15 @@ enum abstract CharacterRenderType(String) from String to String
   public var MultiSparrow = 'multisparrow';
 
   /**
-   * Renders the character using a spritesheet of symbols and JSON data.
+   * Renders the character using a single spritesheet of symbols and JSON data.
    */
   public var AnimateAtlas = 'animateatlas';
 
+  /**
+   * Renders the character using multiple spritesheets of symbols and JSON data.
+   */
+  public var MultiAnimateAtlas = 'multianimateatlas';
+
   /**
    * Renders the character using a custom method.
    */
@@ -674,6 +729,9 @@ typedef CharacterData =
    */
   var healthIcon:Null<HealthIconData>;
 
+  /**
+   * Optional data about the death animation for the character.
+   */
   var death:Null<DeathData>;
 
   /**
@@ -734,6 +792,23 @@ typedef CharacterData =
    * @default false
    */
   var flipX:Null<Bool>;
+
+  /**
+   * NOTE: This only applies to animate atlas characters.
+   *
+   * Whether to apply the stage matrix, if it was exported from a symbol instance.
+   * Also positions the Texture Atlas as it displays in Animate.
+   * Turning this on is only recommended if you prepositioned the character in Animate.
+   * For other cases, it should be turned off to act similarly to a normal FlxSprite.
+   */
+  var applyStageMatrix:Null<Bool>;
+
+  /**
+   * Various settings for the prop.
+   * Only available for texture atlases.
+   */
+  @:optional
+  var atlasSettings:funkin.data.stage.StageData.TextureAtlasData;
 };
 
 /**

source/funkin/data/character/CharacterData.hx

@@ -103,6 +103,10 @@ class PlayerFreeplayDJData
   var assetPath:String;
   var animations:Array<AnimationData>;
 
+  @:optional
+  @:default(false)
+  var applyStageMatrix:Bool;
+
   @:optional
   @:default("BOYFRIEND")
   var text1:String;
@@ -158,11 +162,16 @@ class PlayerFreeplayDJData
   }
 
   public inline function getAssetPath():String
-    return assetPath; // return Paths.animateAtlas(assetPath);
+    return assetPath; // return assetPath;
 
   public inline function getAnimationsList():Array<AnimationData>
     return animations;
 
+  public function useApplyStageMatrix():Bool
+  {
+    return applyStageMatrix;
+  }
+
   public function getFreeplayDJText(index:Int):String
   {
     switch (index)
@@ -343,6 +352,10 @@ typedef PlayerResultsAnimationData =
    */
   var renderType:String;
 
+  @:optional
+  @:default(false)
+  var applyStageMatrix:Bool;
+
   @:optional
   var assetPath:Null<String>;
 

source/funkin/data/freeplay/player/PlayerData.hx

@@ -196,7 +196,7 @@ typedef StageDataProp =
 
   /**
    * The animation type to use.
-   * Options: "sparrow", "packer"
+   * Options: "sparrow", "packer", "animateatlas"
    * @default "sparrow"
    */
   @:default("sparrow")
@@ -228,6 +228,52 @@ typedef StageDataProp =
   @:default("#FFFFFF")
   @:optional
   var color:String;
+
+  /**
+   * Various settings for the prop.
+   * Only available for texture atlases.
+   */
+  @:optional
+  var atlasSettings:TextureAtlasData;
+};
+
+typedef TextureAtlasData =
+{
+  /**
+   * If true, the texture atlas will behave as if it was exported as an SWF file.
+   * Notably, this allows MovieClip symbols to play.
+   */
+  @:optional
+  var swfMode:Bool;
+
+  /**
+   * If true, filters and masks will be cached when the atlas is loaded, instead of during runtime.
+   */
+  @:optional
+  var cacheOnLoad:Bool;
+
+  /**
+   * The filter quality.
+   * Available values are: HIGH, MEDIUM, LOW, and RUDY.
+   *
+   * If you're making an atlas sprite in HScript, you pass an Int instead:
+   *
+   * HIGH - 0
+   * MEDIUM - 1
+   * LOW - 2
+   * RUDY - 3
+   */
+  @:optional
+  var filterQuality:Int;
+
+  /**
+   * Whether to apply the stage matrix, if it was exported from a symbol instance.
+   * Also positions the Texture Atlas as it displays in Animate.
+   * Turning this on is only recommended if you prepositioned the character in Animate.
+   * For other cases, it should be turned off to act similarly to a normal FlxSprite.
+   */
+  @:optional
+  var applyStageMatrix:Bool;
 };
 
 typedef StageDataCharacter =