Navigation
These archived docs are for Phaser 2.2.2 Phaser 3 docs can be found on newdocs.phaser.io.
Phaser CE docs can be found on the Phaser CE Documentation site.

Constructor

Phaser. AnimationParser

new AnimationParser()

Responsible for parsing sprite sheet and JSON data into the internal FrameData format that Phaser uses for animations.

Source code: animation/AnimationParser.js, line 13

Public Methods

<static> JSONData(game, json, cacheKey) → {Phaser.FrameData}

Parse the JSON data and extract the animation frame data from it.

Parameters
Name Type Description
game Phaser.Game

A reference to the currently running game.
json object

The JSON data from the Texture Atlas. Must be in Array format.
cacheKey string

The Game.Cache asset key of the texture image.
Returns
Phaser.FrameData -

A FrameData object containing the parsed frames.

Source code: animation/AnimationParser.js, line 99

<static> JSONDataHash(game, json, cacheKey) → {Phaser.FrameData}

Parse the JSON data and extract the animation frame data from it.

Parameters
Name Type Description
game Phaser.Game

A reference to the currently running game.
json object

The JSON data from the Texture Atlas. Must be in JSON Hash format.
cacheKey string

The Game.Cache asset key of the texture image.
Returns
Phaser.FrameData -

A FrameData object containing the parsed frames.

Source code: animation/AnimationParser.js, line 164

<static> spriteSheet(game, key, frameWidth, frameHeight, frameMax, margin, spacing) → {Phaser.FrameData}

Parse a Sprite Sheet and extract the animation frame data from it.

Parameters
Name Type Argument Default Description
game Phaser.Game

A reference to the currently running game.
key string

The Game.Cache asset key of the Sprite Sheet image.
frameWidth number

The fixed width of each frame of the animation.
frameHeight number

The fixed height of each frame of the animation.
frameMax number <optional>
 -1

The total number of animation frames to extact from the Sprite Sheet. The default value of -1 means "extract all frames".
margin number <optional>
 0

If the frames have been drawn with a margin, specify the amount here.
spacing number <optional>
 0

If the frames have been drawn with spacing between them, specify the amount here.
Returns
Phaser.FrameData -

A FrameData object containing the parsed frames.

Source code: animation/AnimationParser.js, line 15

<static> XMLData(game, xml, cacheKey) → {Phaser.FrameData}

Parse the XML data and extract the animation frame data from it.

Parameters
Name Type Description
game Phaser.Game

A reference to the currently running game.
xml object

The XML data from the Texture Atlas. Must be in Starling XML format.
cacheKey string

The Game.Cache asset key of the texture image.
Returns
Phaser.FrameData -

A FrameData object containing the parsed frames.

Source code: animation/AnimationParser.js, line 232