Class: Phaser.AnimationParser

Constructor

new AnimationParser()

Source code: animation/AnimationParser.js (Line 13)

Public Methods

<static> JSONData(game, json) → {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.

Returns

Phaser.FrameData -

A FrameData object containing the parsed frames.

Source code: animation/AnimationParser.js (Line 93)

<static> JSONDataHash(game, json) → {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.

Returns

Phaser.FrameData -

A FrameData object containing the parsed frames.

Source code: animation/AnimationParser.js (Line 204)

<static> JSONDataPyxel(game, json) → {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 Pyxel JSON format.

Returns

Phaser.FrameData -

A FrameData object containing the parsed frames.

Source code: animation/AnimationParser.js (Line 147)

<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 | Image			The Game.Cache asset key of the Sprite Sheet image or an actual HTML Image element.
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 extract 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) → {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.

Returns

Phaser.FrameData -

A FrameData object containing the parsed frames.

Source code: animation/AnimationParser.js (Line 261)