Class: FrameData

Methods

<static> addFrame(frame) → {Phaser.Animation.Frame}

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

Parameters:

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

Source:

• animation/FrameData.js, line 33

Returns:

The frame that was just added.

Type

Phaser.Animation.Frame

<static> 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.

Source:

• animation/FrameData.js, line 94

Returns:

True if the frame is found, otherwise false.

Type

boolean

<static> getFrame(index) → {Phaser.Animation.Frame}

Get a Frame by its numerical index.

Parameters:

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

Source:

• animation/FrameData.js, line 56

Returns:

The frame, if found.

Type

Phaser.Animation.Frame

<static> getFrameByName(name) → {Phaser.Animation.Frame}

Get a Frame by its frame name.

Parameters:

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

Source:

• animation/FrameData.js, line 75

Returns:

The frame, if found.

Type

Phaser.Animation.Frame

<static> 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			An Array containing the indexes of the frames to retrieve. If 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.

Source:

• animation/FrameData.js, line 184

Returns:

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

Type

Array

<static> 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.

Source:

• animation/FrameData.js, line 113

Returns:

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

Type

Array

<static> 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			An Array containing the indexes of the frames to retrieve. If 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.

Source:

• animation/FrameData.js, line 136

Returns:

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

Type

Array

<static> total() → {number}

Returns the total number of frames in this FrameData set.

Source:

• animation/FrameData.js, line 233

Returns:

The total number of frames in this FrameData set.

Type

number