Phaser API Documentation

The key that the animation will be associated with. i.e. sprite.animations.play(key)

Either a string, in which case it will use all frames from a texture with the matching key, or an array of Animation Frame configuration objects.

If you provide a string for frames you can optionally have the frame names numerically sorted.

The key of the texture all frames of the animation will use. Can be overridden on a per frame basis.

The frame rate of playback in frames per second (default 24 if duration is null)

How long the animation should play for in milliseconds. If not given its derived from frameRate.

Skip frames if the time lags, or always advanced anyway?

Delay before starting playback. Value given in milliseconds.

Number of times to repeat the animation (-1 for infinity)

Delay before the animation repeats. Value given in milliseconds.

Should the animation yoyo? (reverse back down to the start) before repeating?

Should sprite.visible = true when the animation starts to play?

Should sprite.visible = false when the animation finishes?

The key of the texture within the Texture Manager to use for this Animation Frame.

The key, or index number, of the frame within the texture to use for this Animation Frame.

The duration, in ms, of this frame of the animation.

Should the parent Game Object be visible during this frame of the animation?

The string to append to every resulting frame name if using a range or an array of frames.

If frames is not provided, the number of the first frame to return.

If frames is not provided, the number of the last frame to return.

The string to append to every resulting frame name if using a range or an array of frames.

The minimum expected lengths of each resulting frame's number. Numbers will be left-padded with zeroes until they are this long, then prepended and appended to create the resulting frame name.

The array to append the created configuration objects to.

If provided as an array, the range defined by start and end will be ignored and these frame numbers will be used.

The starting frame of the animation.

The ending frame of the animation.

A frame to put at the beginning of the animation, before start or outputArray or frames.

An array to concatenate the output onto.

A custom sequence of frames.

The key that the animation will be associated with. i.e. sprite.animations.play(key)

A frame based animation (as opposed to a bone based animation)

An array of the AnimationFrame objects inside this Animation.

The frame rate of playback in frames per second (default 24 if duration is null)

How long the animation should play for in milliseconds. If not given its derived from frameRate.

Skip frames if the time lags, or always advanced anyway?

Delay before starting playback. Value given in milliseconds.

Number of times to repeat the animation (-1 for infinity)

Delay before the animation repeats. Value given in milliseconds.

Should the animation yoyo? (reverse back down to the start) before repeating?

Should sprite.visible = true when the animation starts to play?

Should sprite.visible = false when the animation finishes?

The key of the Texture this AnimationFrame uses.

The key of the Frame within the Texture that this AnimationFrame uses.

Additional time (in ms) that this frame should appear for during playback.

An array of all Animations added to the Animation Manager.

The global time scale of the Animation Manager.

The string-based key of the animation to play, or an Animation instance.

The frame rate of playback in frames per second (default 24 if duration is null)

How long the animation should play for in milliseconds. If not given its derived from frameRate.

Delay before starting playback. Value given in milliseconds.

Number of times to repeat the animation (-1 for infinity)

Delay before the animation repeats. Value given in milliseconds.

Should the animation yoyo? (reverse back down to the start) before repeating?

Should sprite.visible = true when the animation starts to play?

Should sprite.visible = false when the animation finishes?

The frame of the animation to start playback from.

The time scale to be applied to playback of this animation.