| name | type | arguments | Default | description |
|---|---|---|---|---|
| targets | any |
The object, or an array of objects, to run each tween on. |
||
| delay | number | function | <optional> | 0 |
The number of milliseconds to delay before the chain will start. |
| completeDelay | string | number | function | object | array | <optional> | 0 |
The time the chain 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 chain will repeat. (A value of 1 means the chain will play twice, as it repeated once.) The first loop starts after every tween has completed once. |
| loopDelay | string | number | function | object | array | <optional> | 0 |
The time the chain will pause before returning to the start for a repeat. |
| paused | boolean | <optional> | false |
Does the chain start in a paused state (true) or playing (false)? |
| tweens | Array.<Phaser.Types.Tweens.TweenBuilderConfig> | <optional> |
The tweens to chain together. |
|
| callbackScope | any | <optional> |
The scope (or context) for all of the callbacks. The default scope is the chain. |
|
| onComplete | Phaser.Types.Tweens.TweenOnCompleteCallback | <optional> |
A function to call when the chain completes. |
|
| onCompleteParams | array | <optional> |
Additional parameters to pass to |
|
| onLoop | Phaser.Types.Tweens.TweenOnLoopCallback | <optional> |
A function to call each time the chain loops. |
|
| onLoopParams | array | <optional> |
Additional parameters to pass to |
|
| onStart | Phaser.Types.Tweens.TweenOnStartCallback | <optional> |
A function to call when the chain starts playback, after any delays have expired. |
|
| onStartParams | array | <optional> |
Additional parameters to pass to |
|
| onStop | Phaser.Types.Tweens.TweenOnStopCallback | <optional> |
A function to call when the chain is stopped. |
|
| onStopParams | array | <optional> |
Additional parameters to pass to |
|
| onActive | Phaser.Types.Tweens.TweenOnActiveCallback | <optional> |
A function to call when the chain becomes active within the Tween Manager. |
|
| onActiveParams | array | <optional> |
Additional parameters to pass to |
|
| onPause | Phaser.Types.Tweens.TweenOnPauseCallback | <optional> |
A function to call when the chain is paused. |
|
| onPauseParams | array | <optional> |
Additional parameters to pass to |
|
| onResume | Phaser.Types.Tweens.TweenOnResumeCallback | <optional> |
A function to call when the chain is resumed after being paused. |
|
| onResumeParams | array | <optional> |
Additional parameters to pass to |
|
| persist | boolean | <optional> |
Will the Tween be automatically destroyed on completion, or retained for future playback? |