Phaser API Documentation

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

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

The duration of the tween in milliseconds.

The easing equation to use for the tween.

Optional easing parameters.

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

The number of times each property tween repeats.

The number of milliseconds to pause before a repeat.

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.

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.

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.

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

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 in the tween has completed once.

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

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

The properties to tween.

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

A function to call when the tween completes.

Additional parameters to pass to onComplete.

A function to call each time the tween loops.

Additional parameters to pass to onLoop.

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

Additional parameters to pass to onRepeat.

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

Additional parameters to pass to onStart.

A function to call when the tween is stopped.

Additional parameters to pass to onStop.

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

Additional parameters to pass to onUpdate.

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

Additional parameters to pass to onYoyo.

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

Additional parameters to pass to onActive.

A function to call when the tween is paused.

Additional parameters to pass to onPause.

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

Additional parameters to pass to onResume.

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

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