Class: Phaser.FrameData

Constructor

new FrameData()

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

Public Properties

[readonly] total : number

The total number of frames in this FrameData set.

Source code: animation/FrameData.js (Line 267)

Public Methods

addFrame(frame) → {Phaser.Frame}

Adds a new Frame to this FrameData collection. Typically called by the Animation.Parser and not directly.

Parameters

Name	Type	Description
frame	Phaser.Frame	The frame to add to this FrameData set.

Returns

Phaser.Frame -

The frame that was just added.

Source code: animation/FrameData.js (Line 31)

checkFrameName(name) → {boolean}

Check if there is a Frame with the given name.

Parameters

Name	Type	Description
name	string	The name of the frame you want to check.

Returns

boolean -

True if the frame is found, otherwise false.

Source code: animation/FrameData.js (Line 89)

clone() → {Phaser.FrameData}

Makes a copy of this FrameData including copies (not references) to all of the Frames it contains.

Returns

Phaser.FrameData -

A clone of this object, including clones of the Frame objects it contains.

Source code: animation/FrameData.js (Line 107)

destroy()

Destroys this FrameData collection by nulling the _frames and _frameNames arrays.

Source code: animation/FrameData.js (Line 251)

getFrame(index) → {Phaser.Frame}

Get a Frame by its numerical index.

Parameters

Name	Type	Description
index	number	The index of the frame you want to get.

Returns

Phaser.Frame -

The frame, if found.

Source code: animation/FrameData.js (Line 53)

getFrameByName(name) → {Phaser.Frame}

Get a Frame by its frame name.

Parameters

Name	Type	Description
name	string	The name of the frame you want to get.

Returns

Phaser.Frame -

The frame, if found.

Source code: animation/FrameData.js (Line 71)

getFrameIndexes(frames, useNumericIndex, output) → {Array}

Returns all of the Frame indexes in this FrameData set.
The frames indexes are returned in the output array, or if none is provided in a new Array object.

Parameters

Name	Type	Argument	Default	Description
frames	Array	<optional>		An Array containing the indexes of the frames to retrieve. If undefined or the array is empty then all frames in the FrameData are returned.
useNumericIndex	boolean	<optional>	true	Are the given frames using numeric indexes (default) or strings? (false)
output	Array	<optional>		If given the results will be appended to the end of this array otherwise a new array will be created.

Returns

Array -

An array of all Frame indexes matching the given names or IDs.

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

getFrameRange(start, end, output) → {Array}

Returns a range of frames based on the given start and end frame indexes and returns them in an Array.

Parameters

Name	Type	Argument	Description
start	number		The starting frame index.
end	number		The ending frame index.
output	Array	<optional>	If given the results will be appended to the end of this array otherwise a new array will be created.

Returns

Array -

An array of Frames between the start and end index values, or an empty array if none were found.

Source code: animation/FrameData.js (Line 135)

getFrames(frames, useNumericIndex, output) → {Array}

Returns all of the Frames in this FrameData set where the frame index is found in the input array.
The frames are returned in the output array, or if none is provided in a new Array object.

Parameters

Name	Type	Argument	Default	Description
frames	Array	<optional>		An Array containing the indexes of the frames to retrieve. If the array is empty or undefined then all frames in the FrameData are returned.
useNumericIndex	boolean	<optional>	true	Are the given frames using numeric indexes (default) or strings? (false)
output	Array	<optional>		If given the results will be appended to the end of this array otherwise a new array will be created.

Returns

Array -

An array of all Frames in this FrameData set matching the given names or IDs.

Source code: animation/FrameData.js (Line 157)