You are browsing legacy Phaser documentation that is 4+ years out of date. Please see https://newdocs.phaser.io

Class: AnimationFrame

Phaser.Animations. AnimationFrame

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.

new AnimationFrame(textureKey, textureFrame, index, frame [, isKeyFrame])

Parameters:
Name Type Argument 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?
Since: 3.0.0
Source: src/animations/AnimationFrame.js (Line 9)

Members

duration :number

Additional time (in ms) that this frame should appear for during playback. The value is added onto the msPerFrame set by the animation.

Type:
  • number
Since: 3.0.0
Default Value:
  • 0
Source: src/animations/AnimationFrame.js (Line 117)

frame :Phaser.Textures.Frame

A reference to the Texture Frame this AnimationFrame uses for rendering.

Type:
Since: 3.0.0
Source: src/animations/AnimationFrame.js (Line 64)

index :number

The index of this AnimationFrame within the Animation sequence.

Type:
  • number
Since: 3.0.0
Source: src/animations/AnimationFrame.js (Line 55)

<readonly> isFirst :boolean

Is this the first frame in an animation sequence?

Type:
  • boolean
Since: 3.0.0
Default Value:
  • false
Source: src/animations/AnimationFrame.js (Line 73)

isKeyFrame :boolean

Is this Frame a KeyFrame within the Animation?

Type:
  • boolean
Since: 3.50.0
Source: src/animations/AnimationFrame.js (Line 140)

<readonly> isLast :boolean

Is this the last frame in an animation sequence?

Type:
  • boolean
Since: 3.0.0
Default Value:
  • false
Source: src/animations/AnimationFrame.js (Line 84)

<readonly, nullable> nextFrame :Phaser.Animations.AnimationFrame

A reference to the AnimationFrame that comes after this one in the animation, if any.

Type:
Since: 3.0.0
Default Value:
  • null
Source: src/animations/AnimationFrame.js (Line 106)

<readonly, nullable> prevFrame :Phaser.Animations.AnimationFrame

A reference to the AnimationFrame that comes before this one in the animation, if any.

Type:
Since: 3.0.0
Default Value:
  • null
Source: src/animations/AnimationFrame.js (Line 95)

<readonly> progress :number

What % through the animation does this frame come? This value is generated when the animation is created and cached here.

Type:
  • number
Since: 3.0.0
Default Value:
  • 0
Source: src/animations/AnimationFrame.js (Line 128)

textureFrame :string|number

The key of the Frame within the Texture that this AnimationFrame uses.

Type:
  • string | number
Since: 3.0.0
Source: src/animations/AnimationFrame.js (Line 46)

textureKey :string

The key of the Texture this AnimationFrame uses.

Type:
  • string
Since: 3.0.0
Source: src/animations/AnimationFrame.js (Line 37)

Methods

destroy()

Destroys this object by removing references to external resources and callbacks.

Since: 3.0.0
Source: src/animations/AnimationFrame.js (Line 168)

toJSON()

Generates a JavaScript object suitable for converting to JSON.

Since: 3.0.0
Source: src/animations/AnimationFrame.js (Line 150)
Returns:

The AnimationFrame data.

Type
Phaser.Types.Animations.JSONAnimationFrame