Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord
Namespace: Tweens
Phaser.Types.Tweens

Type Definitions

TweenConfigDefaults
Focus
Focus
Properties:
name type arguments Default description
targets object | Array.<object>

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

delay number <optional> 0

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

duration number <optional> 1000

The duration of the tween in milliseconds.

ease string <optional> 'Power0'

The easing equation to use for the tween.

easeParams array <optional>

Optional easing parameters.

hold number <optional> 0

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

repeat number <optional> 0

The number of times to repeat the tween.

repeatDelay number <optional> 0

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

yoyo boolean <optional> 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 <optional> 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 <optional> 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.

Type:
object
Since: 3.0.0
Focus
Focus
Event
Focus
Focus

Description:

A Tween Event.

Type:
string
Since: 3.19.0
Focus
Focus
GetActiveCallback(target, key, value, targetIndex, totalTargets, tween)
Focus
Focus

Parameters:

name type description
target any

The tween target.

key string

The target property.

value number

The current value of the target property.

targetIndex number

The index of the target within the Tween.

totalTargets number

The total number of targets in this Tween.

tween Phaser.Tweens.Tween

The Tween that invoked this callback.

Type:
function
Returns:
Description:
  • The new value.
Type:
  • number
Since: 3.19.0
Focus
Focus
GetEndCallback(target, key, value, targetIndex, totalTargets, tween)
Focus
Focus

Parameters:

name type description
target any

The tween target.

key string

The target property.

value number

The current value of the target property.

targetIndex number

The index of the target within the Tween.

totalTargets number

The total number of targets in this Tween.

tween Phaser.Tweens.Tween

The Tween that invoked this callback.

Type:
function
Returns:
Description:
  • The new value.
Type:
  • number
Since: 3.18.0
Focus
Focus
GetStartCallback(target, key, value, targetIndex, totalTargets, tween)
Focus
Focus

Parameters:

name type description
target any

The tween target.

key string

The target property.

value number

The current value of the target property.

targetIndex number

The index of the target within the Tween.

totalTargets number

The total number of targets in this Tween.

tween Phaser.Tweens.Tween

The Tween that invoked this callback.

Type:
function
Returns:
Description:
  • The new value.
Type:
  • number
Since: 3.18.0
Focus
Focus
NumberTweenBuilderConfig
Focus
Focus
Properties:
name type arguments Default description
from number <optional> 0

The start number.

to number <optional> 1

The end number.

delay number <optional> 0

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

duration number <optional> 1000

The duration of the tween in milliseconds.

ease string | function <optional> 'Power0'

The easing equation to use for the tween.

easeParams array <optional>

Optional easing parameters.

hold number <optional> 0

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

repeat number <optional> 0

The number of times to repeat the tween.

repeatDelay number <optional> 0

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

yoyo boolean <optional> 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.

offset string | number | function | object | array <optional> null

Used when the Tween is part of a Timeline.

completeDelay string | number | function | object | array <optional> 0

The time the tween will wait before the onComplete event is dispatched once it has completed, in ms.

loop string | number | function | object | array <optional> 0

The number of times the tween will repeat. (A value of 1 means the tween will play twice, as it repeated once.) The first loop starts after every property tween has completed once.

loopDelay string | number | function | object | array <optional> 0

The time the tween will pause before starting either a yoyo or returning to the start for a repeat.

paused boolean <optional> false

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

useFrames boolean <optional> false

Use frames or milliseconds?

callbackScope any <optional>

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

onComplete Phaser.Types.Tweens.TweenOnCompleteCallback <optional>

A function to call when the tween completes.

onCompleteParams array <optional>

Additional parameters to pass to onComplete.

onCompleteScope any <optional>

Scope (this) for onComplete.

onLoop Phaser.Types.Tweens.TweenOnLoopCallback <optional>

A function to call each time the tween loops.

onLoopParams array <optional>

Additional parameters to pass to onLoop.

onLoopScope any <optional>

Scope (this) for onLoop.

onRepeat Phaser.Types.Tweens.TweenOnRepeatCallback <optional>

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

onRepeatParams array <optional>

Additional parameters to pass to onRepeat.

onRepeatScope any <optional>

Scope (this) for onRepeat.

onStart Phaser.Types.Tweens.TweenOnStartCallback <optional>

A function to call when the tween starts.

onStartParams array <optional>

Additional parameters to pass to onStart.

onStartScope any <optional>

Scope (this) for onStart.

onStop Phaser.Types.Tweens.TweenOnStopCallback <optional>

A function to call when the tween is stopped.

onStopParams array <optional>

Additional parameters to pass to onStop.

onStopScope any <optional>

Scope (this) for onStop.

onUpdate Phaser.Types.Tweens.TweenOnUpdateCallback <optional>

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

onUpdateParams array <optional>

Additional parameters to pass to onUpdate.

onUpdateScope any <optional>

Scope (this) for onUpdate.

onYoyo Phaser.Types.Tweens.TweenOnYoyoCallback <optional>

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

onYoyoParams array <optional>

Additional parameters to pass to onYoyo.

onYoyoScope any <optional>

Scope (this) for onYoyo.

Type:
object
Since: 3.18.0
Focus
Focus
StaggerConfig
Focus
Focus
Properties:
name type arguments Default description
start number <optional> 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 <optional> 'Linear'

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

from string | number <optional> 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> <optional>

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.

Type:
object
Since: 3.19.0
Focus
Focus
TimelineBuilderConfig
Focus
Focus
Properties:
name type arguments Default description
tweens Array.<object> | function | Array.<Phaser.Types.Tweens.TweenBuilderConfig> <optional>

An array of tween configuration objects to create and add into the new Timeline. If this doesn't exist or is empty, the Timeline will start off paused and none of the other configuration settings will be read. If it's a function, it will be called and its return value will be used as the array.

targets any <optional>

An array (or function which returns one) of default targets to which to apply the Timeline. Each individual Tween configuration can override this value.

totalDuration number <optional> 0

If specified, each Tween in the Timeline will get an equal portion of this duration, usually in milliseconds, by default. Each individual Tween configuration can override the Tween's duration.

duration number <optional> 1000

If totalDuration is not specified, the default duration, usually in milliseconds, of each Tween which will be created. Each individual Tween configuration can override the Tween's duration.

delay number <optional> 0

The number of milliseconds to delay before the tween will start. Each individual Tween configuration can override this value.

easeParams array <optional>

Optional easing parameters. Each individual Tween configuration can override this value.

ease string | function <optional> 'Power0'

The easing equation to use for each tween. Each individual Tween configuration can override this value.

hold number <optional> 0

The number of milliseconds to hold each tween before yoyo'ing. Each individual Tween configuration can override this value.

repeat number <optional> 0

The number of times to repeat each tween. Each individual Tween configuration can override this value.

repeatDelay number <optional> 0

The number of milliseconds to pause before each tween will repeat. Each individual Tween configuration can override this value.

yoyo boolean <optional> false

Should each 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. Each individual Tween configuration can override this value.

flipX boolean <optional> 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. Each individual Tween configuration can override this value.

flipY boolean <optional> 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. Each individual Tween configuration can override this value.

completeDelay number | function | object | array <optional> 0

If specified, the time to wait, usually in milliseconds, before the Timeline completes.

loop number | function | object | array <optional> 0

How many times the Timeline should loop, or -1 to loop indefinitely.

loopDelay number | function | object | array <optional> 0

The time, usually in milliseconds, between each loop.

paused boolean <optional> false

If true, the Timeline will start paused.

useFrames boolean <optional> false

If true, all duration in the Timeline will be in frames instead of milliseconds.

callbackScope any <optional>

The default scope (this value) to use for each callback registered by the Timeline Builder. If not specified, the Timeline itself will be used.

onStart Phaser.Types.Tweens.TimelineOnStartCallback <optional>

If specified, the onStart callback for the Timeline, called every time it starts playing.

onStartScope any <optional>

The scope (this value) to use for the onStart callback. If not specified, the callbackScope will be used.

onStartParams array <optional>

Additional arguments to pass to the onStart callback. The Timeline will always be the first argument.

onUpdate Phaser.Types.Tweens.TimelineOnUpdateCallback <optional>

If specified, the onUpdate callback for the Timeline, called every frame it's active, regardless of its Tweens.

onUpdateScope any <optional>

The scope (this value) to use for the onUpdate callback. If not specified, the callbackScope will be used.

onUpdateParams array <optional>

Additional arguments to pass to the onUpdate callback. The Timeline will always be the first argument.

onLoop Phaser.Types.Tweens.TimelineOnLoopCallback <optional>

If specified, the onLoop callback for the Timeline, called every time it loops.

onLoopScope any <optional>

The scope (this value) to use for the onLoop callback. If not specified, the callbackScope will be used.

onLoopParams array <optional>

Additional arguments to pass to the onLoop callback. The Timeline will always be the first argument.

onYoyo Phaser.Types.Tweens.TimelineOnYoyoCallback <optional>

If specified, the onYoyo callback for the Timeline, called every time it yoyos.

onYoyoScope any <optional>

The scope (this value) to use for the onYoyo callback. If not specified, the callbackScope will be used.

onYoyoParams array <optional>

Additional arguments to pass to the onYoyo callback. The first argument will always be null, while the Timeline will always be the second argument.

onComplete Phaser.Types.Tweens.TimelineOnCompleteCallback <optional>

If specified, the onComplete callback for the Timeline, called after it completes.

onCompleteScope any <optional>

The scope (this value) to use for the onComplete callback. If not specified, the callbackScope will be used.

onCompleteParams array <optional>

Additional arguments to pass to the onComplete callback. The Timeline will always be the first argument.

Type:
object
Since: 3.18.0
Focus
Focus
TimelineOnCompleteCallback(timeline, param)
Focus
Focus

Parameters:

name type description
timeline Phaser.Tweens.Timeline

The timeline.

param any

Any value passed in onCompleteParams.

Type:
function
Focus
Focus
TimelineOnLoopCallback(timeline, param)
Focus
Focus

Parameters:

name type description
timeline Phaser.Tweens.Timeline

The timeline.

param any

Any value passed in onLoopParams.

Type:
function
Since: 3.18.0
Focus
Focus
TimelineOnStartCallback(timeline, param)
Focus
Focus

Parameters:

name type description
timeline Phaser.Tweens.Timeline

The timeline.

param any

Any value passed in onStartParams.

Type:
function
Since: 3.18.0
Focus
Focus
TimelineOnUpdateCallback(timeline, param)
Focus
Focus

Parameters:

name type description
timeline Phaser.Tweens.Timeline

The timeline.

param any

Any value passed in onUpdateParams.

Type:
function
Since: 3.18.0
Focus
Focus
TimelineOnYoyoCallback(timeline, param)
Focus
Focus

Parameters:

name type description
timeline Phaser.Tweens.Timeline

The timeline.

param any

Any value passed in onYoyoParams.

Type:
function
Since: 3.18.0
Focus
Focus
TweenBuilderConfig
Focus
Focus
Properties:
name type arguments Default description
targets any

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

delay number | function <optional> 0

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

duration number <optional> 1000

The duration of the tween in milliseconds.

ease string | function <optional> 'Power0'

The easing equation to use for the tween.

easeParams array <optional>

Optional easing parameters.

hold number <optional> 0

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

repeat number <optional> 0

The number of times each property tween repeats.

repeatDelay number <optional> 0

The number of milliseconds to pause before a repeat.

yoyo boolean <optional> 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 <optional> 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 <optional> 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.

offset string | number | function | object | array <optional> null

Used when the Tween is part of a Timeline.

completeDelay string | number | function | object | array <optional> 0

The time the tween will wait before the onComplete event is dispatched once it has completed, in ms.

loop string | number | function | object | array <optional> 0

The number of times the tween will repeat. (A value of 1 means the tween will play twice, as it repeated once.) The first loop starts after every property tween has completed once.

loopDelay string | number | function | object | array <optional> 0

The time the tween will pause before starting either a yoyo or returning to the start for a repeat.

paused boolean <optional> 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)> <optional>

The properties to tween.

useFrames boolean <optional> false

Use frames or milliseconds?

callbackScope any <optional>

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

onComplete Phaser.Types.Tweens.TweenOnCompleteCallback <optional>

A function to call when the tween completes.

onCompleteParams array <optional>

Additional parameters to pass to onComplete.

onCompleteScope any <optional>

Scope (this) for onComplete.

onLoop Phaser.Types.Tweens.TweenOnLoopCallback <optional>

A function to call each time the tween loops.

onLoopParams array <optional>

Additional parameters to pass to onLoop.

onLoopScope any <optional>

Scope (this) for onLoop.

onRepeat Phaser.Types.Tweens.TweenOnRepeatCallback <optional>

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

onRepeatParams array <optional>

Additional parameters to pass to onRepeat.

onRepeatScope any <optional>

Scope (this) for onRepeat.

onStart Phaser.Types.Tweens.TweenOnStartCallback <optional>

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

onStartParams array <optional>

Additional parameters to pass to onStart.

onStartScope any <optional>

Scope (this) for onStart.

onStop Phaser.Types.Tweens.TweenOnStopCallback <optional>

A function to call when the tween is stopped.

onStopParams array <optional>

Additional parameters to pass to onStop.

onStopScope any <optional>

Scope (this) for onStop.

onUpdate Phaser.Types.Tweens.TweenOnUpdateCallback <optional>

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

onUpdateParams array <optional>

Additional parameters to pass to onUpdate.

onUpdateScope any <optional>

Scope (this) for onUpdate.

onYoyo Phaser.Types.Tweens.TweenOnYoyoCallback <optional>

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

onYoyoParams array <optional>

Additional parameters to pass to onYoyo.

onYoyoScope any <optional>

Scope (this) for onYoyo.

onActive Phaser.Types.Tweens.TweenOnActiveCallback <optional>

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

onActiveParams array <optional>

Additional parameters to pass to onActive.

onActiveScope any <optional>

Scope (this) for onActive.

Type:
object
Since: 3.18.0
Focus
Focus
TweenDataConfig
Focus
Focus
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
Focus
Focus
TweenDataGenConfig
Focus
Focus
Properties:
name type description
delay function

Time in ms/frames before tween will start.

duration function

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

hold function

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

repeat function

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

Time in ms/frames before the repeat will start.

Type:
object
Since: 3.0.0
Focus
Focus
TweenOnActiveCallback(tween, target, param)
Focus
Focus

Parameters:

name type description
tween Phaser.Tweens.Tween

The tween.

target any

The tween target.

param any

Any value passed in onActiveParams.

Type:
function
Since: 3.19.0
Focus
Focus
TweenOnCompleteCallback(tween, targets, param)
Focus
Focus

Parameters:

name type description
tween Phaser.Tweens.Tween

The tween.

targets array

The tween targets.

param any

Any value passed in onCompleteParams.

Type:
function
Since: 3.18.0
Focus
Focus
TweenOnLoopCallback(tween, targets, param)
Focus
Focus

Parameters:

name type description
tween Phaser.Tweens.Tween

The tween.

targets array

The tween targets.

param any

Any value passed in onLoopParams.

Type:
function
Since: 3.18.0
Focus
Focus
TweenOnRepeatCallback(tween, target, param)
Focus
Focus

Parameters:

name type description
tween Phaser.Tweens.Tween

The tween.

target any

The tween target.

param any

Any value passed in onRepeatParams.

Type:
function
Since: 3.18.0
Focus
Focus
TweenOnStartCallback(tween, targets, param)
Focus
Focus

Parameters:

name type description
tween Phaser.Tweens.Tween

The tween.

targets array

The tween targets.

param any

Any value passed in onStartParams.

Type:
function
Since: 3.18.0
Focus
Focus
TweenOnStopCallback(tween, targets, param)
Focus
Focus

Parameters:

name type description
tween Phaser.Tweens.Tween

The tween.

targets array

The tween targets.

param any

Any value passed in onStopParams.

Type:
function
Since: 3.24.0
Focus
Focus
TweenOnUpdateCallback(tween, target, param)
Focus
Focus

Parameters:

name type description
tween Phaser.Tweens.Tween

The tween.

target any

The tween target.

param any

Any value passed in onUpdateParams.

Type:
function
Since: 3.18.0
Focus
Focus
TweenOnYoyoCallback(tween, target, param)
Focus
Focus

Parameters:

name type description
tween Phaser.Tweens.Tween

The tween.

target any

The tween target.

param any

Any value passed in onYoyoParams.

Type:
function
Since: 3.18.0
Focus
Focus
TweenPropConfig
Focus
Focus
Properties:
name type arguments description
value number | string | Phaser.Types.Tweens.GetEndCallback | Phaser.Types.Tweens.TweenPropConfig <optional>

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

getActive Phaser.Types.Tweens.GetActiveCallback <optional>

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

getEnd Phaser.Types.Tweens.GetEndCallback <optional>

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

getStart Phaser.Types.Tweens.GetStartCallback <optional>

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

ease string | function <optional>

The ease function this tween uses.

delay number <optional>

Time in ms/frames before tween will start.

duration number <optional>

Duration of the tween in ms/frames.

yoyo boolean <optional>

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

hold number <optional>

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

repeat number <optional>

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>

Time in ms/frames before the repeat will start.

flipX boolean <optional>

Should toggleFlipX be called when yoyo or repeat happens?

flipY boolean <optional>

Should toggleFlipY be called when yoyo or repeat happens?

Type:
object
Since: 3.18.0
Focus
Focus