new AnimationManager(sprite)
The Animation Manager is used to add, play and update Phaser Animations. Any Game Object such as Phaser.Sprite that supports animation contains a single AnimationManager instance.
Parameters:
| Name | Type | Description |
|---|---|---|
sprite |
Phaser.Sprite | A reference to the Game Object that owns this AnimationManager. |
- Source:
Members
-
currentFrame
-
- Default Value:
- null
- Source:
Properties:
Name Type Description currentFramePhaser.Frame The currently displayed Frame of animation, if any.
-
frame
-
- Source:
Properties:
Name Type Description framenumber Gets or sets the current frame index and updates the Texture Cache for display.
-
<readonly> frameData
-
- Source:
Properties:
Name Type Description frameDataPhaser.FrameData The current animations FrameData.
-
frameName
-
- Source:
Properties:
Name Type Description frameNamestring Gets or sets the current frame name and updates the Texture Cache for display.
-
<readonly> frameTotal
-
- Source:
Properties:
Name Type Description frameTotalnumber The total number of frames in the currently loaded FrameData, or -1 if no FrameData is loaded.
-
game
-
- Source:
Properties:
Name Type Description gamePhaser.Game A reference to the currently running Game.
-
isLoaded
-
- Default Value:
- false
- Source:
Properties:
Name Type Description isLoadedboolean Set to true once animation data has been loaded.
-
paused
-
- Source:
Properties:
Name Type Description pausedboolean Gets and sets the paused state of the current animation.
-
sprite
-
- Source:
Properties:
Name Type Description spritePhaser.Sprite A reference to the parent Sprite that owns this AnimationManager.
-
updateIfVisible
-
- Default Value:
- true
- Source:
Properties:
Name Type Description updateIfVisibleboolean Should the animation data continue to update even if the Sprite.visible is set to false.
Methods
-
add(name, frames, frameRate, loop, useNumericIndex) → {Phaser.Animation}
-
Adds a new animation under the given key. Optionally set the frames, frame rate and loop. Animations added in this way are played back with the play function.
Parameters:
Name Type Argument Default Description namestring The unique (within this Sprite) name for the animation, i.e. "run", "fire", "walk".
framesArray <optional>
null An array of numbers/strings that correspond to the frames to add to this animation and in which order. e.g. [1, 2, 3] or ['run0', 'run1', run2]). If null then all frames will be used.
frameRatenumber <optional>
60 The speed at which the animation should play. The speed is given in frames per second.
loopboolean <optional>
false Whether or not the animation is looped or just plays once.
useNumericIndexboolean <optional>
true Are the given frames using numeric indexes (default) or strings?
- Source:
Returns:
The Animation object that was created.
- Type
- Phaser.Animation
-
destroy()
-
Destroys all references this AnimationManager contains. Sets the _anims to a new object and nulls the current animation.
- Source:
-
getAnimation(name) → {Phaser.Animation|boolean}
-
Returns an animation that was previously added by name.
Parameters:
Name Type Description namestring The name of the animation to be returned, e.g. "fire".
- Source:
Returns:
The Animation instance, if found, otherwise false.
- Type
- Phaser.Animation | boolean
-
play(name, frameRate, loop, killOnComplete) → {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 namestring The name of the animation to be played, e.g. "fire", "walk", "jump".
frameRatenumber <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.
loopboolean <optional>
false Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used.
killOnCompleteboolean <optional>
false If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed.
- Source:
Returns:
A reference to playing Animation instance.
- Type
- Phaser.Animation
-
refreshFrame()
-
Refreshes the current frame data back to the parent Sprite and also resets the texture data.
- Source:
-
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 namestring <optional>
null The name of the animation to be stopped, e.g. "fire". If none is given the currently running animation is stopped.
resetFrameboolean <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:
-
<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:
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 framesArray An array of frames to be validated.
useNumericIndexboolean <optional>
true Validate the frames based on their numeric index (true) or string index (false)
- Source:
Returns:
True if all given Frames are valid, otherwise false.
- Type
- boolean