22 < head >
33 < meta charset ="UTF-8 ">
44 < meta name ="viewport " content ="width=device-width, initial-scale=1.0 ">
5- < title > Psych Engine - FlxAnimate Functions</ title >
5+ < title > Shadow Engine - Flixel Animate Functions</ title >
66 < link rel ="stylesheet " href ="../css/main.css ">
77 < link rel ="stylesheet " href ="../css/header.css ">
88 < link rel ="stylesheet " href ="../css/search.css ">
2929 < div class ="headerbox ">
3030 < div class ="header ">
3131 < a href ="../index.html ">
32- < img width ="64 " src ="../assets/icon.ico " alt ="Psych Engine Logodraggable ="false ">
33- < div class ="headertext "> Psych Engine - Lua Script API</ div >
32+ < img width ="64 " src ="../assets/icon.ico " alt ="Shadow Engine Logodraggable ="false ">
33+ < div class ="headertext "> Shadow Engine - Lua Script API</ div >
3434 </ a >
3535 </ div >
3636 </ div >
3737
3838 <!-- Page Info -->
3939 < div class ="infobox ">
40- < h1 > FlxAnimate Functions</ h1 >
40+ < h1 > Flixel Animate Functions</ h1 >
4141 < p > < b > Functions for creating special Lua Sprites that can use Animate Atlas.</ b > </ p >
4242 < hr >
4343 < h2 id ="makeFlxAnimateSprite "> makeFlxAnimateSprite</ h2 >
4444 < p class ="methodbox "> makeFlxAnimateSprite(< span class ="variablemarkup "> tag</ span > :String, < span class ="isoptional "> ?</ span > < span class ="variablemarkup "> x</ span > :Float = 0, < span class ="isoptional "> ?</ span > < span class ="variablemarkup "> y</ span > :Float = 0, < span class ="isoptional "> ?</ span > < span class ="variablemarkup "> loadFolder</ span > :String = null):Void</ p >
4545 < p > Creates a Lua FlxAnimate Sprite.</ p >
4646 < ul >
47- < li > < b > < span class ="variablemarkup "> tag</ span > </ b > - Lua FlxAnimate Sprite nametag.</ li >
47+ < li > < b > < span class ="variablemarkup "> tag</ span > </ b > - Lua Flixel Animate Sprite nametag.</ li >
4848 < li > < b > < span class ="variablemarkup "> x</ span > (Optional)</ b > - Defaults to 0.</ li >
4949 < li > < b > < span class ="variablemarkup "> y</ span > (Optional)</ b > - Defaults to 0.</ li >
5050 < li > < b > < span class ="variablemarkup "> loadFolder</ span > (Optional)</ b > - Loads the atlas from this path.</ li >
@@ -58,9 +58,9 @@ <h4>Examples:</h4>
5858
5959 < h2 id ="loadAnimateAtlas "> loadAnimateAtlas</ h2 >
6060 < p class ="methodbox "> loadAnimateAtlas(< span class ="variablemarkup "> tag</ span > :String, < span class ="variablemarkup "> folderOrImg</ span > :String, < span class ="isoptional "> ?</ span > < span class ="variablemarkup "> spriteJson</ span > :String = null, < span class ="isoptional "> ?</ span > < span class ="variablemarkup "> animationJson</ span > :String = null):Void</ p >
61- < p > Creates a Lua FlxAnimate Sprite.</ p >
61+ < p > Creates a Lua Flixel Animate Sprite.</ p >
6262 < ul >
63- < li > < b > < span class ="variablemarkup "> tag</ span > </ b > - Lua FlxAnimate Sprite nametag.</ li >
63+ < li > < b > < span class ="variablemarkup "> tag</ span > </ b > - Lua Flixel Animate Sprite nametag.</ li >
6464 < li > < b > < span class ="variablemarkup "> folderOrImg</ span > </ b > - Spritemap .PNG file path.</ li >
6565 < li > < b > < span class ="variablemarkup "> spriteJson</ span > (Optional)</ b > - Spritemap .JSON file path, will use the value in "folderOrImg" if missing.</ li >
6666 < li > < b > < span class ="variablemarkup "> animationJson</ span > (Optional)</ b > - Animation .JSON file path, will use the value in "folderOrImg" if missing.</ li >
@@ -73,41 +73,70 @@ <h4>Examples:</h4>
7373 < hr >
7474
7575 < h2 id ="addAnimationBySymbol "> addAnimationBySymbol</ h2 >
76- < p class ="methodbox "> addAnimationBySymbol(< span class ="variablemarkup "> tag</ span > :String, < span class ="variablemarkup "> name</ span > :String, < span class ="variablemarkup "> symbol</ span > :String, < span class ="isoptional "> ?</ span > < span class ="variablemarkup "> framerate</ span > :Float = 24, < span class ="isoptional "> ?</ span > < span class ="variablemarkup "> loop</ span > :Bool = false, < span class =" isoptional " > ? </ span > < span class =" variablemarkup " > matX </ span > :Float = 0, < span class =" isoptional " > ? </ span > < span class =" variablemarkup " > matY </ span > :Float = 0 ):Void</ p >
76+ < p class ="methodbox "> addAnimationBySymbol(< span class ="variablemarkup "> tag</ span > :String, < span class ="variablemarkup "> name</ span > :String, < span class ="variablemarkup "> symbol</ span > :String, < span class ="isoptional "> ?</ span > < span class ="variablemarkup "> framerate</ span > :Int = 24, < span class ="isoptional "> ?</ span > < span class ="variablemarkup "> loop</ span > :Bool = true ):Void</ p >
7777 < p > Adds an animation from a symbol.</ p >
7878 < ul >
79- < li > < b > < span class ="variablemarkup "> tag</ span > </ b > - Lua FlxAnimate Sprite nametag.</ li >
79+ < li > < b > < span class ="variablemarkup "> tag</ span > </ b > - Lua Flixel Animate Sprite nametag.</ li >
8080 < li > < b > < span class ="variablemarkup "> name</ span > </ b > - Animation name.</ li >
8181 < li > < b > < span class ="variablemarkup "> symbol</ span > </ b > - Symbol name in Adobe Animate (Folder should be included in this!).</ li >
8282 < li > < b > < span class ="variablemarkup "> framerate</ span > (Optional)</ b > - Animation FPS.</ li >
8383 < li > < b > < span class ="variablemarkup "> loop</ span > (Optional)</ b > - Should the animation loop?</ li >
84- < li > < b > < span class ="variablemarkup "> matX</ span > (Optional)</ b > - Matrix Offset X.</ li >
85- < li > < b > < span class ="variablemarkup "> matY</ span > (Optional)</ b > - Matrix Offset Y.</ li >
8684 </ ul >
8785 < h4 > Examples:</ h4 >
8886 < ul class ="methoddiv ">
89- < li class ="exampleitem "> < span class ="methodexample "> addAnimationBySymbol('mySprite', 'idle', 'Test Anim Idle')</ span > - Adds an animation named "idle", symbol is named "Test Anim Idle" on Animate, running at 24 FPS and loop disabled .</ li >
90- < li class ="exampleitem "> < span class ="methodexample "> addAnimationBySymbol('mySprite', 'spin', 'Test Spin', 30, true )</ span > - Adds an animation named "spin", symbol is named "Test Spin" on Animate, running at 30 FPS and loop enabled .</ li >
87+ < li class ="exampleitem "> < span class ="methodexample "> addAnimationBySymbol('mySprite', 'idle', 'Test Anim Idle')</ span > - Adds an animation named "idle", symbol is named "Test Anim Idle" on Animate, running at 24 FPS and loop enabled .</ li >
88+ < li class ="exampleitem "> < span class ="methodexample "> addAnimationBySymbol('mySprite', 'spin', 'Test Spin', 30, false )</ span > - Adds an animation named "spin", symbol is named "Test Spin" on Animate, running at 30 FPS and loop disabled .</ li >
9189 </ ul >
9290 < hr >
9391
9492 < h2 id ="addAnimationBySymbolIndices "> addAnimationBySymbolIndices</ h2 >
95- < p class ="methodbox "> addAnimationBySymbolIndices(< span class ="variablemarkup "> tag</ span > :String, < span class ="variablemarkup "> name</ span > :String, < span class ="variablemarkup "> symbol</ span > :String, < span class ="isoptional " > ? </ span > < span class =" variablemarkup "> indices</ span > :Dynamic = null , < span class ="isoptional "> ?</ span > < span class ="variablemarkup "> framerate</ span > :Float = 24, < span class ="isoptional "> ?</ span > < span class ="variablemarkup "> loop</ span > :Bool = false, < span class =" isoptional " > ? </ span > < span class =" variablemarkup " > matX </ span > :Float = 0, < span class =" isoptional " > ? </ span > < span class =" variablemarkup " > matY </ span > :Float = 0 ):Void</ p >
96- < p > Adds an animation from a symbol.</ p >
93+ < p class ="methodbox "> addAnimationBySymbolIndices(< span class ="variablemarkup "> tag</ span > :String, < span class ="variablemarkup "> name</ span > :String, < span class ="variablemarkup "> symbol</ span > :String, < span class ="variablemarkup "> indices</ span > :String , < span class ="isoptional "> ?</ span > < span class ="variablemarkup "> framerate</ span > :Int = 24, < span class ="isoptional "> ?</ span > < span class ="variablemarkup "> loop</ span > :Bool = true ):Void</ p >
94+ < p > Adds an animation from a symbol using specific frame indices .</ p >
9795 < ul >
98- < li > < b > < span class ="variablemarkup "> tag</ span > </ b > - Lua FlxAnimate Sprite nametag.</ li >
96+ < li > < b > < span class ="variablemarkup "> tag</ span > </ b > - Lua Flixel Animate Sprite nametag.</ li >
9997 < li > < b > < span class ="variablemarkup "> name</ span > </ b > - Animation name.</ li >
10098 < li > < b > < span class ="variablemarkup "> symbol</ span > </ b > - Symbol name in Adobe Animate (Folder should be included in this!).</ li >
101- < li > < b > < span class ="variablemarkup "> indices</ span > </ b > - Animation frames, can be formatted either as a string separated by commas or as a table.</ li >
99+ < li > < b > < span class ="variablemarkup "> indices</ span > </ b > - Animation frames, formatted as a string separated by commas (e.g., "0,1,2,3").</ li >
100+ < li > < b > < span class ="variablemarkup "> framerate</ span > (Optional)</ b > - Animation FPS.</ li >
101+ < li > < b > < span class ="variablemarkup "> loop</ span > (Optional)</ b > - Should the animation loop?</ li >
102+ </ ul >
103+ < h4 > Examples:</ h4 >
104+ < ul class ="methoddiv ">
105+ < li class ="exampleitem "> < span class ="methodexample "> addAnimationBySymbolIndices('mySprite', 'idle', 'Test Anim Idle', '0,1,2,3,4,5,6,7')</ span > - Adds "idle" using the specified frame indices.</ li >
106+ </ ul >
107+ < hr >
108+
109+ < h2 id ="addAnimationByFrameLabel "> addAnimationByFrameLabel</ h2 >
110+ < p class ="methodbox "> addAnimationByFrameLabel(< span class ="variablemarkup "> tag</ span > :String, < span class ="variablemarkup "> name</ span > :String, < span class ="variablemarkup "> label</ span > :String, < span class ="isoptional "> ?</ span > < span class ="variablemarkup "> framerate</ span > :Int = 24, < span class ="isoptional "> ?</ span > < span class ="variablemarkup "> loop</ span > :Bool = true):Void</ p >
111+ < p > Adds an animation from a frame label.</ p >
112+ < ul >
113+ < li > < b > < span class ="variablemarkup "> tag</ span > </ b > - Lua Flixel Animate Sprite nametag.</ li >
114+ < li > < b > < span class ="variablemarkup "> name</ span > </ b > - Animation name.</ li >
115+ < li > < b > < span class ="variablemarkup "> label</ span > </ b > - Frame label name in Adobe Animate.</ li >
116+ < li > < b > < span class ="variablemarkup "> framerate</ span > (Optional)</ b > - Animation FPS.</ li >
117+ < li > < b > < span class ="variablemarkup "> loop</ span > (Optional)</ b > - Should the animation loop?</ li >
118+ </ ul >
119+ < h4 > Examples:</ h4 >
120+ < ul class ="methoddiv ">
121+ < li class ="exampleitem "> < span class ="methodexample "> addAnimationByFrameLabel('mySprite', 'idle', 'IdleLabel')</ span > - Adds an animation named "idle" from the frame label "IdleLabel", running at 24 FPS and loop enabled.</ li >
122+ < li class ="exampleitem "> < span class ="methodexample "> addAnimationByFrameLabel('mySprite', 'walk', 'WalkLabel', 30, false)</ span > - Adds an animation named "walk" from the frame label "WalkLabel", running at 30 FPS and loop disabled.</ li >
123+ </ ul >
124+ < hr >
125+
126+ < h2 id ="addAnimationByFrameLabelIndices "> addAnimationByFrameLabelIndices</ h2 >
127+ < p class ="methodbox "> addAnimationByFrameLabelIndices(< span class ="variablemarkup "> tag</ span > :String, < span class ="variablemarkup "> name</ span > :String, < span class ="variablemarkup "> label</ span > :String, < span class ="variablemarkup "> indices</ span > :String, < span class ="isoptional "> ?</ span > < span class ="variablemarkup "> framerate</ span > :Int = 24, < span class ="isoptional "> ?</ span > < span class ="variablemarkup "> loop</ span > :Bool = true):Void</ p >
128+ < p > Adds an animation from a frame label using specific frame indices.</ p >
129+ < ul >
130+ < li > < b > < span class ="variablemarkup "> tag</ span > </ b > - Lua Flixel Animate Sprite nametag.</ li >
131+ < li > < b > < span class ="variablemarkup "> name</ span > </ b > - Animation name.</ li >
132+ < li > < b > < span class ="variablemarkup "> label</ span > </ b > - Frame label name in Adobe Animate.</ li >
133+ < li > < b > < span class ="variablemarkup "> indices</ span > </ b > - Animation frames, formatted as a string separated by commas (e.g., "0,1,2,3").</ li >
102134 < li > < b > < span class ="variablemarkup "> framerate</ span > (Optional)</ b > - Animation FPS.</ li >
103135 < li > < b > < span class ="variablemarkup "> loop</ span > (Optional)</ b > - Should the animation loop?</ li >
104- < li > < b > < span class ="variablemarkup "> matX</ span > (Optional)</ b > - Matrix Offset X.</ li >
105- < li > < b > < span class ="variablemarkup "> matY</ span > (Optional)</ b > - Matrix Offset Y.</ li >
106136 </ ul >
107137 < h4 > Examples:</ h4 >
108138 < ul class ="methoddiv ">
109- < li class ="exampleitem "> < span class ="methodexample "> addAnimationBySymbolIndices('mySprite', 'idle', 'Test Anim Idle', '0, 1, 2, 3, 4, 5, 6, 7')</ span > - Adds "idle" using string indices.</ li >
110- < li class ="exampleitem "> < span class ="methodexample "> addAnimationBySymbolIndices('mySprite', 'idle', 'Test Anim Idle', {0, 1, 2, 3, 4, 5, 6, 7})</ span > - Adds "idle" using table indices.</ li >
139+ < li class ="exampleitem "> < span class ="methodexample "> addAnimationByFrameLabelIndices('mySprite', 'idle', 'IdleLabel', '0,1,2,3')</ span > - Adds "idle" from the frame label "IdleLabel" using the specified frame indices.</ li >
111140 </ ul >
112141 </ body >
113142</ html >
0 commit comments