Types.Tweens

targets

object | Array.<object>

No

The object, or an array of objects, to run the tween on.

delay

number

Yes

0

The number of milliseconds to delay before the tween will start.

duration

number

Yes

1000

The duration of the tween in milliseconds.

ease

string

Yes

"'Power0'"

The easing equation to use for the tween.

easeParams

array

Yes

Optional easing parameters.

hold

number

Yes

0

The number of milliseconds to hold the tween for before yoyo'ing.

repeat

number

Yes

0

The number of times to repeat the tween.

repeatDelay

number

Yes

0

The number of milliseconds to pause before a tween will repeat.

yoyo

boolean

Yes

false

Should the tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take duration milliseconds to complete.

flipX

boolean

Yes

false

Horizontally flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the flipX property.

flipY

boolean

Yes

false

Vertically flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the flipY property.

persist

boolean

Yes

false

Retain the tween within the Tween Manager, even after playback completes?

interpolation

function

Yes

null

The interpolation function to use for array-based tween values.

from

number

Yes

0

The start number.

to

number

Yes

1

The end number.

delay

number

Yes

0

The number of milliseconds to delay before the counter will start.

duration

number

Yes

1000

The duration of the counter in milliseconds.

ease

string | function

Yes

"'Power0'"

The easing equation to use for the counter.

easeParams

array

Yes

Optional easing parameters.

hold

number

Yes

0

The number of milliseconds to hold the counter for before yoyo'ing.

repeat

number

Yes

0

The number of times to repeat the counter.

repeatDelay

number

Yes

0

The number of milliseconds to pause before the counter will repeat.

yoyo

boolean

Yes

false

Should the counter play forward to the end value and then backwards to the start? The reverse playback will also take duration milliseconds to complete.

completeDelay

string | number

function

object

array

loop

string | number

function

object

array

loopDelay

string | number

function

object

array

paused

boolean

Yes

false

Does the counter start in a paused state (true) or playing (false)?

callbackScope

any

Yes

Scope (this) for the callbacks. The default scope is the counter.

onComplete

Phaser.Types.Tweens.TweenOnCompleteCallback

Yes

A function to call when the counter completes.

onCompleteParams

array

Yes

Additional parameters to pass to onComplete.

onLoop

Phaser.Types.Tweens.TweenOnLoopCallback

Yes

A function to call each time the counter loops.

onLoopParams

array

Yes

Additional parameters to pass to onLoop.

onRepeat

Phaser.Types.Tweens.TweenOnRepeatCallback

Yes

A function to call each time the counter repeats.

onRepeatParams

array

Yes

Additional parameters to pass to onRepeat.

onStart

Phaser.Types.Tweens.TweenOnStartCallback

Yes

A function to call when the counter starts.

onStartParams

array

Yes

Additional parameters to pass to onStart.

onStop

Phaser.Types.Tweens.TweenOnStopCallback

Yes

A function to call when the counter is stopped.

onStopParams

array

Yes

Additional parameters to pass to onStop.

onUpdate

Phaser.Types.Tweens.TweenOnUpdateCallback

Yes

A function to call each time the counter steps.

onUpdateParams

array

Yes

Additional parameters to pass to onUpdate.

onYoyo

Phaser.Types.Tweens.TweenOnYoyoCallback

Yes

A function to call each time the counter yoyos.

onYoyoParams

array

Yes

Additional parameters to pass to onYoyo.

onPause

Phaser.Types.Tweens.TweenOnPauseCallback

Yes

A function to call when the counter is paused.

onPauseParams

array

Yes

Additional parameters to pass to onPause.

onResume

Phaser.Types.Tweens.TweenOnResumeCallback

Yes

A function to call when the counter is resumed after being paused.

onResumeParams

array

Yes

Additional parameters to pass to onResume.

persist

boolean

Yes

Will the counter be automatically destroyed on completion, or retained for future playback?

interpolation

string | function

Yes

The interpolation function to use if the value given is an array of numbers.

start

number

Yes

0

The value to start the stagger from. Can be used as a way to offset the stagger while still using a range for the value.

ease

string | function

Yes

"'Linear'"

An ease to apply across the staggered values. Can either be a string, such as 'sine.inout', or a function.

from

string | number

Yes

0

The index to start the stagger from. Can be the strings first, last or center, or an integer representing the stagger position.

grid

Array.<number>

Yes

Set the stagger to run across a grid by providing an array where element 0 is the width of the grid and element 1 is the height. Combine with the 'from' property to control direction.

targets

any

No

The object, or an array of objects, to run the tween on.

delay

number | function

Yes

0

The number of milliseconds to delay before the tween will start.

duration

number

Yes

1000

The duration of the tween in milliseconds.

ease

string | function

Yes

"'Power0'"

The easing equation to use for the tween.

easeParams

array

Yes

Optional easing parameters.

hold

number

Yes

0

The number of milliseconds to hold the tween for before yoyo'ing.

repeat

number

Yes

0

The number of times each property tween repeats.

repeatDelay

number

Yes

0

The number of milliseconds to pause before a repeat.

yoyo

boolean

Yes

false

Should the tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take duration milliseconds to complete.

flipX

boolean

Yes

false

Horizontally flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the flipX property.

flipY

boolean

Yes

false

Vertically flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the flipY property.

completeDelay

string | number

function

object

array

loop

string | number

function

object

array

loopDelay

string | number

function

object

array

paused

boolean

Yes

false

Does the tween start in a paused state (true) or playing (false)?

props

Object.<string, (number, string, Phaser.Types.Tweens.GetEndCallback, Phaser.Types.Tweens.TweenPropConfig)>

Yes

The properties to tween.

callbackScope

any

Yes

The scope (or context) for all of the callbacks. The default scope is the tween.

onComplete

Phaser.Types.Tweens.TweenOnCompleteCallback

Yes

A function to call when the tween completes.

onCompleteParams

array

Yes

Additional parameters to pass to onComplete.

onLoop

Phaser.Types.Tweens.TweenOnLoopCallback

Yes

A function to call each time the tween loops.

onLoopParams

array

Yes

Additional parameters to pass to onLoop.

onRepeat

Phaser.Types.Tweens.TweenOnRepeatCallback

Yes

A function to call each time a property tween repeats. Called once per property per target.

onRepeatParams

array

Yes

Additional parameters to pass to onRepeat.

onStart

Phaser.Types.Tweens.TweenOnStartCallback

Yes

A function to call when the tween starts playback, after any delays have expired.

onStartParams

array

Yes

Additional parameters to pass to onStart.

onStop

Phaser.Types.Tweens.TweenOnStopCallback

Yes

A function to call when the tween is stopped.

onStopParams

array

Yes

Additional parameters to pass to onStop.

onUpdate

Phaser.Types.Tweens.TweenOnUpdateCallback

Yes

A function to call each time the tween steps. Called once per property per target.

onUpdateParams

array

Yes

Additional parameters to pass to onUpdate.

onYoyo

Phaser.Types.Tweens.TweenOnYoyoCallback

Yes

A function to call each time a property tween yoyos. Called once per property per target.

onYoyoParams

array

Yes

Additional parameters to pass to onYoyo.

onActive

Phaser.Types.Tweens.TweenOnActiveCallback

Yes

A function to call when the tween becomes active within the Tween Manager.

onActiveParams

array

Yes

Additional parameters to pass to onActive.

onPause

Phaser.Types.Tweens.TweenOnPauseCallback

Yes

A function to call when the tween is paused.

onPauseParams

array

Yes

Additional parameters to pass to onPause.

onResume

Phaser.Types.Tweens.TweenOnResumeCallback

Yes

A function to call when the tween is resumed after being paused.

onResumeParams

array

Yes

Additional parameters to pass to onResume.

persist

boolean

Yes

Will the Tween be automatically destroyed on completion, or retained for future playback?

interpolation

string | function

Yes

The interpolation function to use if the value given is an array of numbers.

onActive

Phaser.Types.Tweens.TweenOnActiveCallback

Yes

A function to call when the tween becomes active within the Tween Manager.

onStart

Phaser.Types.Tweens.TweenOnStartCallback

Yes

A function to call when the tween starts playback, after any delays have expired.

onComplete

Phaser.Types.Tweens.TweenOnCompleteCallback

Yes

A function to call when the tween completes.

onLoop

Phaser.Types.Tweens.TweenOnLoopCallback

Yes

A function to call each time the tween loops.

onPause

Phaser.Types.Tweens.TweenOnPauseCallback

Yes

A function to call each time the tween is paused.

onResume

Phaser.Types.Tweens.TweenOnResumeCallback

Yes

A function to call each time the tween is resumed.

onRepeat

Phaser.Types.Tweens.TweenOnRepeatCallback

Yes

A function to call each time the tween repeats. Called once per property per target.

onStop

Phaser.Types.Tweens.TweenOnStopCallback

Yes

A function to call when the tween is stopped.

onUpdate

Phaser.Types.Tweens.TweenOnUpdateCallback

Yes

A function to call each time the tween steps. Called once per property per target.

onYoyo

Phaser.Types.Tweens.TweenOnYoyoCallback

Yes

A function to call each time the tween yoyos. Called once per property per target.

targets

any

No

The object, or an array of objects, to run each tween on.

delay

number | function

Yes

0

The number of milliseconds to delay before the chain will start.

completeDelay

string | number

function

object

array

loop

string | number

function

object

array

loopDelay

string | number

function

object

array

paused

boolean

Yes

false

Does the chain start in a paused state (true) or playing (false)?

tweens

Array.<Phaser.Types.Tweens.TweenBuilderConfig>

Yes

The tweens to chain together.

callbackScope

any

Yes

The scope (or context) for all of the callbacks. The default scope is the chain.

onComplete

Phaser.Types.Tweens.TweenOnCompleteCallback

Yes

A function to call when the chain completes.

onCompleteParams

array

Yes

Additional parameters to pass to onComplete.

onLoop

Phaser.Types.Tweens.TweenOnLoopCallback

Yes

A function to call each time the chain loops.

onLoopParams

array

Yes

Additional parameters to pass to onLoop.

onStart

Phaser.Types.Tweens.TweenOnStartCallback

Yes

A function to call when the chain starts playback, after any delays have expired.

onStartParams

array

Yes

Additional parameters to pass to onStart.

onStop

Phaser.Types.Tweens.TweenOnStopCallback

Yes

A function to call when the chain is stopped.

onStopParams

array

Yes

Additional parameters to pass to onStop.

onActive

Phaser.Types.Tweens.TweenOnActiveCallback

Yes

A function to call when the chain becomes active within the Tween Manager.

onActiveParams

array

Yes

Additional parameters to pass to onActive.

onPause

Phaser.Types.Tweens.TweenOnPauseCallback

Yes

A function to call when the chain is paused.

onPauseParams

array

Yes

Additional parameters to pass to onPause.

onResume

Phaser.Types.Tweens.TweenOnResumeCallback

Yes

A function to call when the chain is resumed after being paused.

onResumeParams

array

Yes

Additional parameters to pass to onResume.

persist

boolean

Yes

Will the Tween be automatically destroyed on completion, or retained for future playback?

target

any

No

The target to tween.

index

number

No

The target index within the Tween targets array.

key

string

No

The property of the target being tweened.

getActiveValue

Phaser.Types.Tweens.GetActiveCallback

No

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

No

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

getStartValue

Phaser.Types.Tweens.GetStartCallback

No

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

ease

function

No

The ease function this tween uses.

duration

number

Yes

0

Duration of the tween in milliseconds, excludes time for yoyo or repeats.

totalDuration

number

Yes

0

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

delay

number

Yes

0

Time in milliseconds before tween will start.

yoyo

boolean

Yes

false

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

hold

number

Yes

0

Time in milliseconds the tween will pause before running the yoyo or starting a repeat.

repeat

number

Yes

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

Yes

0

Time in milliseconds before the repeat will start.

flipX

boolean

Yes

false

Automatically call toggleFlipX when the TweenData yoyos or repeats

flipY

boolean

Yes

false

Automatically call toggleFlipY when the TweenData yoyos or repeats

progress

number

Yes

0

Between 0 and 1 showing completion of this TweenData.

elapsed

number

Yes

0

Delta counter

repeatCounter

number

Yes

0

How many repeats are left to run?

start

number

Yes

0

The property value at the start of the ease.

current

number

Yes

0

The current propety value.

previous

number

Yes

0

The previous property value.

end

number

Yes

0

The property value at the end of the ease.

gen

Phaser.Types.Tweens.TweenDataGenConfig

Yes

LoadValue generation functions.

state

Phaser.Tweens.StateType

Yes

0

TWEEN_CONST.CREATED

delay

function

No

Time in milliseconds before tween will start.

duration

function

No

Duration of the tween in milliseconds, excludes time for yoyo or repeats.

hold

function

No

Time in milliseconds the tween will pause before running the yoyo or starting a repeat.

repeat

function

No

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

function

No

Time in milliseconds before the repeat will start.

target

any

No

The target to tween.

index

number

No

The target index within the Tween targets array.

key

string

No

The property of the target being tweened.

duration

number

Yes

0

Duration of the tween in milliseconds, excludes time for yoyo or repeats.

totalDuration

number

Yes

0

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

delay

number

Yes

0

Time in milliseconds before tween will start.

hold

number

Yes

0

Time in milliseconds the tween will pause before running the yoyo or starting a repeat.

repeat

number

Yes

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

Yes

0

Time in milliseconds before the repeat will start.

flipX

boolean

Yes

false

Automatically call toggleFlipX when the TweenData yoyos or repeats

flipY

boolean

Yes

false

Automatically call toggleFlipY when the TweenData yoyos or repeats

progress

number

Yes

0

Between 0 and 1 showing completion of this TweenData.

elapsed

number

Yes

0

Delta counter

repeatCounter

number

Yes

0

How many repeats are left to run?

gen

Phaser.Types.Tweens.TweenDataGenConfig

Yes

LoadValue generation functions.

state

Phaser.Tweens.StateType

Yes

0

TWEEN_CONST.CREATED

value

number | Array.<number>

string

Phaser.Types.Tweens.GetEndCallback

getActive

Phaser.Types.Tweens.GetActiveCallback

Yes

What the property will be set to immediately when this tween becomes active.

getEnd

Phaser.Types.Tweens.GetEndCallback

Yes

What the property will be at the END of the Tween.

getStart

Phaser.Types.Tweens.GetStartCallback

Yes

What the property will be at the START of the Tween.

ease

string | function

Yes

The ease function this tween uses.

delay

number

Yes

Time in milliseconds before tween will start.

duration

number

Yes

Duration of the tween in milliseconds.

yoyo

boolean

Yes

Determines whether the tween should return back to its start value after hold has expired.

hold

number

Yes

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

repeat

number

Yes

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

Yes

Time in milliseconds before the repeat will start.

flipX

boolean

Yes

Should toggleFlipX be called when yoyo or repeat happens?

flipY

boolean

Yes

Should toggleFlipY be called when yoyo or repeat happens?

interpolation

string | function

Yes

The interpolation function to use if the value given is an array of numbers.