Global

Methods

destroy()

Destroys all references this AnimationManager contains. Sets the _anims to a new object and nulls the current animation.

Source:

• animation/AnimationManager.js, line 246

play(name, frameRate, loop) → {Phaser.Animation}

Play an animation based on the given key. The animation should previously have been added via sprite.animations.add() If the requested animation is already playing this request will be ignored. If you need to reset an already running animation do so directly on the Animation object itself.

Parameters:

Name	Type	Argument	Default	Description
name	string			The name of the animation to be played, e.g. "fire", "walk", "jump".
frameRate	number	<optional>	null	The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used.
loop	boolean	<optional>	null	Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used.

Source:

• animation/AnimationManager.js, line 158

Returns:

A reference to playing Animation instance.

Type

Phaser.Animation

stop(name, resetFrame)

Stop playback of an animation. If a name is given that specific animation is stopped, otherwise the current animation is stopped. The currentAnim property of the AnimationManager is automatically set to the animation given.

Parameters:

Name	Type	Argument	Default	Description
name	string	<optional>	null	The name of the animation to be stopped, e.g. "fire". If none is given the currently running animation is stopped.
resetFrame	boolean	<optional>	false	When the animation is stopped should the currentFrame be set to the first frame of the animation (true) or paused on the last frame displayed (false)

Source:

• animation/AnimationManager.js, line 189

<protected> update() → {boolean}

The main update function is called by the Sprites update loop. It's responsible for updating animation frames and firing related events.

Source:

• animation/AnimationManager.js, line 220

Returns:

True if a new animation frame has been set, otherwise false.

Type

boolean

validateFrames(frames, useNumericIndex) → {boolean}

Check whether the frames in the given array are valid and exist.

Parameters:

Name	Type	Argument	Default	Description
frames	Array			An array of frames to be validated.
useNumericIndex	boolean	<optional>	true	Validate the frames based on their numeric index (true) or string index (false)

Source:

• animation/AnimationManager.js, line 123

Returns:

True if all given Frames are valid, otherwise false.

Type

boolean