Phaser API Documentation

  Version: 

Member of: Phaser.Types.Tweens

TweenDataConfig
Properties:
name type arguments Default description
target any

The target to tween.

index number

The target index within the Tween targets array.

key string

The property of the target being tweened.

getActiveValue Phaser.Types.Tweens.GetActiveCallback

If not null, is invoked immediately as soon as the TweenData is running, and is set on the target property.

getEndValue Phaser.Types.Tweens.GetEndCallback

The returned value sets what the property will be at the END of the Tween.

getStartValue Phaser.Types.Tweens.GetStartCallback

The returned value sets what the property will be at the START of the Tween.

ease function

The ease function this tween uses.

duration number <optional> 0

Duration of the tween in ms/frames, excludes time for yoyo or repeats.

totalDuration number <optional> 0

The total calculated duration of this TweenData (based on duration, repeat, delay and yoyo)

delay number <optional> 0

Time in ms/frames before tween will start.

yoyo boolean <optional> false

Cause the tween to return back to its start value after hold has expired.

hold number <optional> 0

Time in ms/frames the tween will pause before running the yoyo or starting a repeat.

repeat number <optional> 0

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 <optional> 0

Time in ms/frames before the repeat will start.

flipX boolean <optional> false

Automatically call toggleFlipX when the TweenData yoyos or repeats

flipY boolean <optional> false

Automatically call toggleFlipY when the TweenData yoyos or repeats

progress number <optional> 0

Between 0 and 1 showing completion of this TweenData.

elapsed number <optional> 0

Delta counter

repeatCounter number <optional> 0

How many repeats are left to run?

start number <optional> 0

The property value at the start of the ease.

current number <optional> 0

The current propety value.

previous number <optional> 0

The previous property value.

end number <optional> 0

The property value at the end of the ease.

t1 number <optional> 0

Time duration 1.

t2 number <optional> 0

Time duration 2.

gen Phaser.Types.Tweens.TweenDataGenConfig <optional>

LoadValue generation functions.

state number <optional> 0

TWEEN_CONST.CREATED

Type:
object
Since: 3.0.0