Class: Animator

Methods

fromTo (instance, start, end, loop, callback)PIXI.animate.AnimatorTimeline

Animator.js:106

Play a MovieClip from a start to end frame.

Name	Type	Default	Description
instance	PIXI.animate.MovieClip		Movie clip to play.
start	Number | String		The starting frame index or label.
end	Number | String		The ending frame index or label.
loop	Boolean	false	optional If the animation should loop.
callback	function		optional Optional callback when complete

Returns:

Type	Description
PIXI.animate.AnimatorTimeline	Timeline object for stopping or getting progress.

play (instance, label, callback)PIXI.animate.AnimatorTimeline

Animator.js:43

Play an animation by frame labels. For instance, play animation sequence from "idle" to "idle_stop" or "idle_loop". If no event label is provided, will play the entire duration of the MovieClip.

Name	Type	Description
instance	PIXI.animate.MovieClip	Movie clip to play.
label	String | function	optional The frame label event to call, if no event is provided will use the entire length of the MovieClip. Can also be the callback.
callback	function	optional Optional callback when complete

Returns:

Type	Description
PIXI.animate.AnimatorTimeline	Timeline object for stopping or getting progress.

stop (instance)

Animator.js:167

Stop the animation by instance.

Name	Type	Description
instance	PIXI.animate.MovieClip	Movie clip to play.

stopAll ()

Animator.js:183

Stop all the currently playing animations.

to (instance, end, callback)PIXI.animate.AnimatorTimeline

Animator.js:87

Play an animation from the current frame to an end frame or label.

Name	Type	Description
instance	PIXI.animate.MovieClip	Movie clip to play.
end	String | Number	The end frame or label.
callback	function	optional Optional callback when complete

Returns:

Type	Description
PIXI.animate.AnimatorTimeline	Timeline object for stopping or getting progress.