Filter
A single frame in an Animation sequence.
An AnimationFrame consists of a reference to the Texture it uses for rendering, references to other frames in the animation, and index data. It also has the ability to modify the animation timing.
AnimationFrames are generated automatically by the Animation class.
Constructor:
new AnimationFrame(textureKey, textureFrame, index, frame, [isKeyFrame])
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| textureKey | string |
The key of the Texture this AnimationFrame uses. |
||
| textureFrame | string | number |
The key of the Frame within the Texture that this AnimationFrame uses. |
||
| index | number |
The index of this AnimationFrame within the Animation sequence. |
||
| frame | Phaser.Textures.Frame |
A reference to the Texture Frame this AnimationFrame uses for rendering. |
||
| isKeyFrame | boolean | <optional> | false |
Is this Frame a Keyframe within the Animation? |
Members
Description:
Additional time (in ms) that this frame should appear for during playback. The value is added onto the msPerFrame set by the animation.
Type:
Description:
A reference to the Texture Frame this AnimationFrame uses for rendering.
Type:
Description:
The index of this AnimationFrame within the Animation sequence.
Type:
Description:
Is this the first frame in an animation sequence?
Type:
Description:
Is this Frame a KeyFrame within the Animation?
Type:
Description:
Is this the last frame in an animation sequence?
Type:
Description:
A reference to the AnimationFrame that comes after this one in the animation, if any.
Description:
A reference to the AnimationFrame that comes before this one in the animation, if any.
Description:
What % through the animation does this frame come? This value is generated when the animation is created and cached here.
Type:
Description:
The key of the Frame within the Texture that this AnimationFrame uses.
Type:
Description:
The key of the Texture this AnimationFrame uses.
Type:
Methods
Description:
Destroys this object by removing references to external resources and callbacks.
Description:
Generates a JavaScript object suitable for converting to JSON.
Returns:
Description:
The AnimationFrame data.