Phaser API Documentation

  Version: 

Member of: Phaser.Types.Tweens

NumberTweenBuilderConfig
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