FlxAnimate Functions
Functions for creating special Lua Sprites that can use Animate Atlas.
makeFlxAnimateSprite
makeFlxAnimateSprite(tag:String, ?x:Float = 0, ?y:Float = 0, ?loadFolder:String = null):Void
Creates a Lua FlxAnimate Sprite.
- tag - Lua FlxAnimate Sprite nametag.
- x (Optional) - Defaults to 0.
- y (Optional) - Defaults to 0.
- loadFolder (Optional) - Loads the atlas from this path.
Examples:
- makeFlxAnimateSprite('mySprite') - Creates an Atlas sprite with no Animate Atlas loaded, which can be loaded later on with "loadAnimateAtlas".
- makeFlxAnimateSprite('mySprite', 500, 300, 'characters/atlasTest') - Loads the Atlas folder mods/My-Mod/images/characters/atlasTest.
loadAnimateAtlas
loadAnimateAtlas(tag:String, folderOrImg:String, ?spriteJson:String = null, ?animationJson:String = null):Void
Creates a Lua FlxAnimate Sprite.
- tag - Lua FlxAnimate Sprite nametag.
- folderOrImg - Spritemap .PNG file path.
- spriteJson (Optional) - Spritemap .JSON file path, will use the value in "folderOrImg" if missing.
- animationJson (Optional) - Animation .JSON file path, will use the value in "folderOrImg" if missing.
Examples:
- loadAnimateAtlas('mySprite', 'characters/atlasTest') - Loads the Atlas folder mods/My-Mod/images/characters/atlasTest.
- loadAnimateAtlas('mySprite', 'characters/atlasTest/spritemap1', 'characters/atlasTest/spritemap1', 'characters/atlasTest/Animation') - This will load the following Animate Atlas files consecutively: mods/My-Mod/images/characters/spritemap1.png, mods/My-Mod/images/characters/spritemap1.json, mods/My-Mod/images/characters/Animation.json.
addAnimationBySymbol
addAnimationBySymbol(tag:String, name:String, symbol:String, ?framerate:Float = 24, ?loop:Bool = false, ?matX:Float = 0, ?matY:Float = 0):Void
Adds an animation from a symbol.
- tag - Lua FlxAnimate Sprite nametag.
- name - Animation name.
- symbol - Symbol name in Adobe Animate (Folder should be included in this!).
- framerate (Optional) - Animation FPS.
- loop (Optional) - Should the animation loop?
- matX (Optional) - Matrix Offset X.
- matY (Optional) - Matrix Offset Y.
Examples:
- addAnimationBySymbol('mySprite', 'idle', 'Test Anim Idle') - Adds an animation named "idle", symbol is named "Test Anim Idle" on Animate, running at 24 FPS and loop disabled.
- addAnimationBySymbol('mySprite', 'spin', 'Test Spin', 30, true) - Adds an animation named "spin", symbol is named "Test Spin" on Animate, running at 30 FPS and loop enabled.
addAnimationBySymbolIndices
addAnimationBySymbolIndices(tag:String, name:String, symbol:String, ?indices:Dynamic = null, ?framerate:Float = 24, ?loop:Bool = false, ?matX:Float = 0, ?matY:Float = 0):Void
Adds an animation from a symbol.
- tag - Lua FlxAnimate Sprite nametag.
- name - Animation name.
- symbol - Symbol name in Adobe Animate (Folder should be included in this!).
- indices - Animation frames, can be formatted either as a string separated by commas or as a table.
- framerate (Optional) - Animation FPS.
- loop (Optional) - Should the animation loop?
- matX (Optional) - Matrix Offset X.
- matY (Optional) - Matrix Offset Y.
Examples:
- addAnimationBySymbolIndices('mySprite', 'idle', 'Test Anim Idle', '0, 1, 2, 3, 4, 5, 6, 7') - Adds "idle" using string indices.
- addAnimationBySymbolIndices('mySprite', 'idle', 'Test Anim Idle', {0, 1, 2, 3, 4, 5, 6, 7}) - Adds "idle" using table indices.