Plugin.NodeFXSequence Class
Binds an AnimSequence instance to a Node instance. The API and namespace is the same as NodeFX, so you can plug NodeFXSequence into any node that just needs to run/pause/stop an animation.
Pass sequence
in the configuration to set the initial animation
sequence.
Constructor
Plugin.NodeFXSequence
(
-
config
Parameters:
-
config
Objectconfiguration
Item Index
Attributes
Methods
append
(
-
item
Append items to the sequence.
pause
()
chainable
Pauses the sequence. If the current item is a delay, the sequence will
pause after the delay interval finishes.
prepend
(
-
item
Prepend items to the sequence.
run
()
chainable
Starts or resumes the sequence.
stop
(
chainable
-
finish
Stops and resets the sequence.
Parameters:
-
finish
BooleanIf true, the animation will move to the last frame.
Attributes
direction
String
The behavior of the animation when "iterations" > 1:
If "normal", the animation will repeat in the same direction.
If "alternate", the animation will flip "reverse" at the end of the sequence.
Default: "normal"
iterationCount
Number
readonly
The number of times the animation has run. Resets to zero when
the animation finishes or is stopped.
iterations
Number | String
The number of times the animation should run. Can be "infinite"
Default: 1
Events
end
Fires after the sequence finishes.
item
Fires when an item in the sequence begins.
Event Payload:
-
index
Intthe item index
pause
Fires when the sequence is paused.
resume
Fires when the sequence resumes (after being paused).
start
Fires when the sequence begins.