Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . Animations . AnimationManager

This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . Animations . AnimationManager

The Animation Manager.

Animations are managed by the global Animation Manager. This is a singleton class that is responsible for creating and delivering animations and their corresponding data to all Game Objects. Unlike plugins it is owned by the Game instance, not the Scene.

Sprites and other Game Objects get the data they need from the AnimationManager.

Constructor:

new AnimationManager(game)

Parameters:

name type description
game Phaser.Game

A reference to the Phaser.Game instance.

Since: 3.0.0

Extends


Members

<protected> anims: Phaser.Structs.Map.<string, Phaser.Animations.Animation>
Focus
Focus

Description:

The Animations registered in the Animation Manager.

This map should be modified with the #add and #create methods of the Animation Manager.

Type:
Since: 3.0.0
Focus
Focus
<protected> game: Phaser.Game
Focus
Focus

Description:

A reference to the Phaser.Game instance.

Type:
Since: 3.0.0
Focus
Focus
globalTimeScale: number
Focus
Focus

Description:

The global time scale of the Animation Manager.

This scales the time delta between two frames, thus influencing the speed of time for the Animation Manager.

Type:
number
Default: 1
Since: 3.0.0
Focus
Focus

Description:

A list of animation mix times.

See the #setMix method for more details.

Type:
Since: 3.50.0
Focus
Focus
name: string
Focus
Focus

Description:

The name of this Animation Manager.

Type:
string
Since: 3.0.0
Focus
Focus
paused: boolean
Focus
Focus

Description:

Whether the Animation Manager is paused along with all of its Animations.

Type:
boolean
Default: false
Since: 3.0.0
Focus
Focus
<protected> textureManager: Phaser.Textures.TextureManager
Focus
Focus

Description:

A reference to the Texture Manager.

Type:
Since: 3.0.0
Focus
Focus

Methods

add(key, animation)
Focus
Focus

Description:

Adds an existing Animation to the Animation Manager.

Parameters:

name type description
key string

The key under which the Animation should be added. The Animation will be updated with it. Must be unique.

animation Phaser.Animations.Animation

The Animation which should be added to the Animation Manager.

Returns:
Description:

This Animation Manager.

Examples:
Since: 3.0.0
Focus
Focus
addListener(event, fn, [context])
Focus
Focus

Description:

Add a listener for a given event.

Parameters:

name type arguments Default description
event string | symbol

The event name.

fn function

The listener function.

context * <optional> this

The context to invoke the listener with.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#addListener
Examples:
Since: 3.0.0
Focus
Focus
addMix(animA, animB, delay)
Focus
Focus

Description:

Adds a mix between two animations.

Mixing allows you to specify a unique delay between a pairing of animations.

When playing Animation A on a Game Object, if you then play Animation B, and a mix exists, it will wait for the specified delay to be over before playing Animation B.

This allows you to customise smoothing between different types of animation, such as blending between an idle and a walk state, or a running and a firing state.

Note that mixing is only applied if you use the Sprite.play method. If you opt to use playAfterRepeat or playAfterDelay instead, those will take pririty and the mix delay will not be used.

To update an existing mix, just call this method with the new delay.

To remove a mix pairing, see the removeMix method.

Parameters:

name type description
animA string | Phaser.Animations.Animation

The string-based key, or instance of, Animation A.

animB string | Phaser.Animations.Animation

The string-based key, or instance of, Animation B.

delay number

The delay, in milliseconds, to wait when transitioning from Animation A to B.

Returns:
Description:

This Animation Manager.

Examples:
Since: 3.50.0
Focus
Focus
boot()
Focus
Focus

Description:

Registers event listeners after the Game boots.

Examples:
Since: 3.0.0
Focus
Focus
create(config)
Focus
Focus

Description:

Creates a new Animation and adds it to the Animation Manager.

Animations are global. Once created, you can use them in any Scene in your game. They are not Scene specific.

If an invalid key is given this method will return false.

If you pass the key of an animation that already exists in the Animation Manager, that animation will be returned.

A brand new animation is only created if the key is valid and not already in use.

If you wish to re-use an existing key, call AnimationManager.remove first, then this method.

Parameters:

name type description
config Phaser.Types.Animations.Animation

The configuration settings for the Animation.

Returns:
Description:

The Animation that was created, or false if the key is already in use.

Examples:
Since: 3.0.0
Focus
Focus
createFromAseprite(key, [tags])
Focus
Focus

Description:

Create one, or more animations from a loaded Aseprite JSON file.

Aseprite is a powerful animated sprite editor and pixel art tool.

You can find more details at https://www.aseprite.org/

To export a compatible JSON file in Aseprite, please do the following:

  1. Go to "File - Export Sprite Sheet"

  2. On the Layout tab: 2a. Set the "Sheet type" to "Packed" 2b. Set the "Constraints" to "None" 2c. Check the "Merge Duplicates" checkbox

  3. On the Sprite tab: 3a. Set "Layers" to "Visible layers" 3b. Set "Frames" to "All frames", unless you only wish to export a sub-set of tags

  4. On the Borders tab: 4a. Check the "Trim Sprite" and "Trim Cells" options 4b. Ensure "Border Padding", "Spacing" and "Inner Padding" are all > 0 (1 is usually enough)

  5. On the Output tab: 5a. Check "Output File", give your image a name and make sure you choose "png files" as the file type 5b. Check "JSON Data" and give your json file a name 5c. The JSON Data type can be either a Hash or Array, Phaser doesn't mind. 5d. Make sure "Tags" is checked in the Meta options 5e. In the "Item Filename" input box, make sure it says just "{frame}" and nothing more.

  6. Click export

This was tested with Aseprite 1.2.25.

This will export a png and json file which you can load using the Aseprite Loader, i.e.:

function preload ()
{
    this.load.path = 'assets/animations/aseprite/';
    this.load.aseprite('paladin', 'paladin.png', 'paladin.json');
}

Once loaded, you can call this method from within a Scene with the 'atlas' key:

this.anims.createFromAseprite('paladin');

Any animations defined in the JSON will now be available to use in Phaser and you play them via their Tag name. For example, if you have an animation called 'War Cry' on your Aseprite timeline, you can play it in Phaser using that Tag name:

this.add.sprite(400, 300).play('War Cry');

When calling this method you can optionally provide an array of tag names, and only those animations will be created. For example:

this.anims.createFromAseprite('paladin', [ 'step', 'War Cry', 'Magnum Break' ]);

This will only create the 3 animations defined. Note that the tag names are case-sensitive.

Parameters:

name type arguments description
key string

The key of the loaded Aseprite atlas. It must have been loaded prior to calling this method.

tags Array.<string> <optional>

An array of Tag names. If provided, only animations found in this array will be created.

Returns:
Description:

An array of Animation instances that were successfully created.

Examples:
Since: 3.50.0
Focus
Focus
destroy()
Focus
Focus

Description:

Destroy this Animation Manager and clean up animation definitions and references to other objects. This method should not be called directly. It will be called automatically as a response to a destroy event from the Phaser.Game instance.

Overrides: Phaser.Events.EventEmitter#destroy
Examples:
Since: 3.0.0
Focus
Focus
emit(event, [args])
Focus
Focus

Description:

Calls each of the listeners registered for a given event.

Parameters:

name type arguments description
event string | symbol

The event name.

args * <optional>

Additional arguments that will be passed to the event handler.

Returns:
Description:

true if the event had listeners, else false.

Type:
  • boolean
Inherited from: Phaser.Events.EventEmitter#emit
Examples:
Since: 3.0.0
Focus
Focus
eventNames()
Focus
Focus

Description:

Return an array listing the events for which the emitter has registered listeners.

Type:
  • Array.<(string
  • symbol)>
Inherited from: Phaser.Events.EventEmitter#eventNames
Examples:
Since: 3.0.0
Focus
Focus
exists(key)
Focus
Focus

Description:

Checks to see if the given key is already in use within the Animation Manager or not.

Animations are global. Keys created in one scene can be used from any other Scene in your game. They are not Scene specific.

Parameters:

name type description
key string

The key of the Animation to check.

Returns:
Description:

true if the Animation already exists in the Animation Manager, or false if the key is available.

Type:
  • boolean
Examples:
Since: 3.16.0
Focus
Focus
fromJSON(data, [clearCurrentAnimations])
Focus
Focus

Description:

Loads this Animation Manager's Animations and settings from a JSON object.

Parameters:

name type arguments Default description
data string | Phaser.Types.Animations.JSONAnimations | Phaser.Types.Animations.JSONAnimation

The JSON object to parse.

clearCurrentAnimations boolean <optional> false

If set to true, the current animations will be removed (anims.clear()). If set to false (default), the animations in data will be added.

Returns:
Description:

An array containing all of the Animation objects that were created as a result of this call.

Examples:
Since: 3.0.0
Focus
Focus
generateFrameNames(key, [config])
Focus
Focus

Description:

Generate an array of Phaser.Types.Animations.AnimationFrame objects from a texture key and configuration object.

Generates objects with string based frame names, as configured by the given Phaser.Types.Animations.GenerateFrameNames.

It's a helper method, designed to make it easier for you to extract all of the frame names from texture atlases. If you're working with a sprite sheet, see the generateFrameNumbers method instead.

Example:

If you have a texture atlases loaded called gems and it contains 6 frames called ruby_0001, ruby_0002, and so on, then you can call this method using: this.anims.generateFrameNames('gems', { prefix: 'ruby_', end: 6, zeroPad: 4 }).

The end value tells it to look for 6 frames, incrementally numbered, all starting with the prefix ruby_. The zeroPad value tells it how many zeroes pad out the numbers. To create an animation using this method, you can do:

this.anims.create({
  key: 'ruby',
  repeat: -1,
  frames: this.anims.generateFrameNames('gems', {
    prefix: 'ruby_',
    end: 6,
    zeroPad: 4
  })
});

Please see the animation examples for further details.

Parameters:

name type arguments description
key string

The key for the texture containing the animation frames.

config Phaser.Types.Animations.GenerateFrameNames <optional>

The configuration object for the animation frame names.

Returns:
Description:

The array of {@link Phaser.Types.Animations.AnimationFrame} objects.

Examples:
Since: 3.0.0
Focus
Focus
generateFrameNumbers(key, config)
Focus
Focus

Description:

Generate an array of Phaser.Types.Animations.AnimationFrame objects from a texture key and configuration object.

Generates objects with numbered frame names, as configured by the given Phaser.Types.Animations.GenerateFrameNumbers.

If you're working with a texture atlas, see the generateFrameNames method instead.

It's a helper method, designed to make it easier for you to extract frames from sprite sheets. If you're working with a texture atlas, see the generateFrameNames method instead.

Example:

If you have a sprite sheet loaded called explosion and it contains 12 frames, then you can call this method using:

this.anims.generateFrameNumbers('explosion', { start: 0, end: 11 }).

The end value of 11 tells it to stop after the 12th frame has been added, because it started at zero.

To create an animation using this method, you can do:

this.anims.create({
  key: 'boom',
  frames: this.anims.generateFrameNames('explosion', {
    start: 0,
    end: 11
  })
});

Note that start is optional and you don't need to include it if the animation starts from frame 0.

To specify an animation in reverse, swap the start and end values.

If the frames are not sequential, you may pass an array of frame numbers instead, for example:

this.anims.generateFrameNumbers('explosion', { frames: [ 0, 1, 2, 1, 2, 3, 4, 0, 1, 2 ] })

Please see the animation examples and GenerateFrameNumbers config docs for further details.

Parameters:

name type description
key string

The key for the texture containing the animation frames.

config Phaser.Types.Animations.GenerateFrameNumbers

The configuration object for the animation frames.

Returns:
Description:

The array of {@link Phaser.Types.Animations.AnimationFrame} objects.

Examples:
Since: 3.0.0
Focus
Focus
get(key)
Focus
Focus

Description:

Get an Animation.

Parameters:

name type description
key string

The key of the Animation to retrieve.

Returns:
Description:

The Animation.

Examples:
Since: 3.0.0
Focus
Focus
getMix(animA, animB)
Focus
Focus

Description:

Returns the mix delay between two animations.

If no mix has been set-up, this method will return zero.

If you wish to create, or update, a new mix, call the addMix method. If you wish to remove a mix, call the removeMix method.

Parameters:

name type description
animA string | Phaser.Animations.Animation

The string-based key, or instance of, Animation A.

animB string | Phaser.Animations.Animation

The string-based key, or instance of, Animation B.

Returns:
Description:

The mix duration, or zero if no mix exists.

Type:
  • number
Examples:
Since: 3.50.0
Focus
Focus
listenerCount(event)
Focus
Focus

Description:

Return the number of listeners listening to a given event.

Parameters:

name type description
event string | symbol

The event name.

Returns:
Description:

The number of listeners.

Type:
  • number
Inherited from: Phaser.Events.EventEmitter#listenerCount
Examples:
Since: 3.0.0
Focus
Focus
listeners(event)
Focus
Focus

Description:

Return the listeners registered for a given event.

Parameters:

name type description
event string | symbol

The event name.

Returns:
Description:

The registered listeners.

Type:
  • Array.
Inherited from: Phaser.Events.EventEmitter#listeners
Examples:
Since: 3.0.0
Focus
Focus
off(event, [fn], [context], [once])
Focus
Focus

Description:

Remove the listeners of a given event.

Parameters:

name type arguments description
event string | symbol

The event name.

fn function <optional>

Only remove the listeners that match this function.

context * <optional>

Only remove the listeners that have this context.

once boolean <optional>

Only remove one-time listeners.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#off
Examples:
Since: 3.0.0
Focus
Focus
on(event, fn, [context])
Focus
Focus

Description:

Add a listener for a given event.

Parameters:

name type arguments Default description
event string | symbol

The event name.

fn function

The listener function.

context * <optional> this

The context to invoke the listener with.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#on
Examples:
Since: 3.0.0
Focus
Focus
once(event, fn, [context])
Focus
Focus

Description:

Add a one-time listener for a given event.

Parameters:

name type arguments Default description
event string | symbol

The event name.

fn function

The listener function.

context * <optional> this

The context to invoke the listener with.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#once
Examples:
Since: 3.0.0
Focus
Focus
pauseAll()
Focus
Focus

Description:

Pause all animations.

Returns:
Description:

This Animation Manager.

Examples:
Since: 3.0.0
Focus
Focus
play(key, children)
Focus
Focus

Description:

Play an animation on the given Game Objects that have an Animation Component.

Parameters:

name type description
key string | Phaser.Animations.Animation | Phaser.Types.Animations.PlayAnimationConfig

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

children Phaser.GameObjects.GameObject | Array.<Phaser.GameObjects.GameObject>

An array of Game Objects to play the animation on. They must have an Animation Component.

Returns:
Description:

This Animation Manager.

Examples:
Since: 3.0.0
Focus
Focus
remove(key)
Focus
Focus

Description:

Removes an Animation from this Animation Manager, based on the given key.

This is a global action. Once an Animation has been removed, no Game Objects can carry on using it.

Parameters:

name type description
key string

The key of the animation to remove.

Returns:
Description:

The Animation instance that was removed from the Animation Manager.

Examples:
Since: 3.0.0
Focus
Focus
removeAllListeners([event])
Focus
Focus

Description:

Remove all listeners, or those of the specified event.

Parameters:

name type arguments description
event string | symbol <optional>

The event name.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#removeAllListeners
Examples:
Since: 3.0.0
Focus
Focus
removeListener(event, [fn], [context], [once])
Focus
Focus

Description:

Remove the listeners of a given event.

Parameters:

name type arguments description
event string | symbol

The event name.

fn function <optional>

Only remove the listeners that match this function.

context * <optional>

Only remove the listeners that have this context.

once boolean <optional>

Only remove one-time listeners.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#removeListener
Examples:
Since: 3.0.0
Focus
Focus
removeMix(animA, [animB])
Focus
Focus

Description:

Removes a mix between two animations.

Mixing allows you to specify a unique delay between a pairing of animations.

Calling this method lets you remove those pairings. You can either remove it between animA and animB, or if you do not provide the animB parameter, it will remove all animA mixes.

If you wish to update an existing mix instead, call the addMix method with the new delay.

Parameters:

name type arguments description
animA string | Phaser.Animations.Animation

The string-based key, or instance of, Animation A.

animB string | Phaser.Animations.Animation <optional>

The string-based key, or instance of, Animation B. If not given, all mixes for Animation A will be removed.

Returns:
Description:

This Animation Manager.

Examples:
Since: 3.50.0
Focus
Focus
resumeAll()
Focus
Focus

Description:

Resume all paused animations.

Returns:
Description:

This Animation Manager.

Examples:
Since: 3.0.0
Focus
Focus
shutdown()
Focus
Focus

Description:

Removes all listeners.

Inherited from: Phaser.Events.EventEmitter#shutdown
Examples:
Since: 3.0.0
Focus
Focus
staggerPlay(key, children, stagger, [staggerFirst])
Focus
Focus

Description:

Takes an array of Game Objects that have an Animation Component and then starts the given animation playing on them. The start time of each Game Object is offset, incrementally, by the stagger amount.

For example, if you pass an array with 4 children and a stagger time of 1000, the delays will be:

child 1: 1000ms delay child 2: 2000ms delay child 3: 3000ms delay child 4: 4000ms delay

If you set the staggerFirst parameter to false they would be:

child 1: 0ms delay child 2: 1000ms delay child 3: 2000ms delay child 4: 3000ms delay

You can also set stagger to be a negative value. If it was -1000, the above would be:

child 1: 3000ms delay child 2: 2000ms delay child 3: 1000ms delay child 4: 0ms delay

Parameters:

name type arguments Default description
key string | Phaser.Animations.Animation | Phaser.Types.Animations.PlayAnimationConfig

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

children Phaser.GameObjects.GameObject | Array.<Phaser.GameObjects.GameObject>

An array of Game Objects to play the animation on. They must have an Animation Component.

stagger number

The amount of time, in milliseconds, to offset each play time by. If a negative value is given, it's applied to the children in reverse order.

staggerFirst boolean <optional> true

Should the first child be staggered as well?

Returns:
Description:

This Animation Manager.

Examples:
Since: 3.0.0
Focus
Focus
toJSON([key])
Focus
Focus

Description:

Returns the Animation data as JavaScript object based on the given key. Or, if not key is defined, it will return the data of all animations as array of objects.

Parameters:

name type arguments description
key string <optional>

The animation to get the JSONAnimation data from. If not provided, all animations are returned as an array.

Returns:
Description:

The resulting JSONAnimations formatted object.

Examples:
Since: 3.0.0
Focus
Focus