Phaser API Documentation

  Version: 

Member of: Phaser.Tweens.Tween

addFrame(targetIndex, texture, frame, delay, duration, hold, repeat, repeatDelay, flipX, flipY)

Description:

Adds a new TweenFrameData to this Tween. Typically, this method is called automatically by the TweenBuilder, however you can also invoke it yourself.

Parameters:

name type description
targetIndex number

The target index within the Tween targets array.

texture string

The texture to set on the target at the end of the tween.

frame string | number

The texture frame to set on the target at the end of the tween.

delay function

Function that returns the time in milliseconds before tween will start.

duration number

The duration of the tween in milliseconds.

hold number

Function that returns the time in milliseconds the tween will pause before repeating or returning to its starting value if yoyo is set to true.

repeat number

Function that returns the number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.

repeatDelay number

Function that returns the time in milliseconds before the repeat will start.

flipX boolean

Should toggleFlipX be called when yoyo or repeat happens?

flipY boolean

Should toggleFlipY be called when yoyo or repeat happens?

Returns:
Description:

The TweenFrameData instance that was added.

Since: 3.60.0