flixel-animate

Flixel-animate is a HaxeFlixel library meant to load texture atlases generated both from Adobe Animate and the BetterTextureAtlas plugin. The library is heavily inspired by FlxAnimate, though with some differences to work similarly to the Flash/Animate JSFL implementation.

Warning

By default flixel-animate will work with a bounds method that acts similarly to how a normal Sparrow flixel sprite would load.
If you are migrating from FlxAnimate these bounds may be different to FlxAnimate's ones.
If you don't want to go through the trouble of fixing them, use the FLX_ANIMATE_LEGACY_BOUNDS define.
I heavily recommend using the default flixel-animate bounds though, to have support for functions that require accurate width and height values like updateHitbox and centerOrigin

How to use

To create a sprite with a loaded texture atlas, create an FlxAnimate sprite object. The class FlxAnimate is meant as a replacement to FlxSprite, its capable of loading both normal atlases (such as Sparrow) and Adobe Animate texture atlases.

Heres a small sample:

import animate.FlxAnimate;
import animate.FlxAnimateFrames;

var sprite:FlxAnimate = new FlxAnimate();
sprite.frames = FlxAnimateFrames.fromAnimate('path/to/atlas');
add(sprite);

sprite.anim.addByTimeline("main animation", sprite.library.timeline);
sprite.anim.play("main animation");

Note that sprite.anim is the same object as sprite.animation! You can use any of them, at your own choice, they both will play both texture atlas and normal flixel animations. sprite.anim only exists for type safety so you can access extra functions like addByTimeline and such.

Ways to add animations

Here's a list of all the ways to add animations when using an Adobe Animate texture atlas.

sprite.anim.addBySymbol("symbolAnim", "symbolName");
sprite.anim.addBySymbolIndices("symbolAnim", "symbolName", [0, 1, 2, 3]);

sprite.anim.addByTimeline("tlAnim", someTimelineObject);
sprite.anim.addByTimelineIndices("tlIndicesAnim", someTimelineObject, [0, 1, 2, 3]);

sprite.anim.addByFrameLabel("labelAnim", "frameLabelName");
sprite.anim.addByFrameLabelIndices("labelIndicesAnim", "frameLabelName", [0, 1, 2, 3])