Sets an event based callback to be invoked during playback.
Calling this method will replace a previously set callback for the given type, if any exists.
The types available are:
onActive
- When the Tween is first created it moves to an 'active' state when added to the Tween Manager. 'Active' does not mean 'playing'.
onStart
- When the Tween starts playing after a delayed or paused state. This will happen at the same time as onActive
if the tween has no delay and isn't paused.
onLoop
- When a Tween loops, if it has been set to do so. This happens after the loopDelay
expires, if set.
onComplete
- When the Tween finishes playback fully. Never invoked if the Tween is set to repeat infinitely.
onStop
- Invoked only if the Tween.stop
method is called.
onPause
- Invoked only if the Tween.pause
method is called. Not invoked if the Tween Manager is paused.
onResume
- Invoked only if the Tween.resume
method is called. Not invoked if the Tween Manager is resumed.
The following types are also available and are invoked on a TweenData
level - that is per-object, per-property, being tweened.
onYoyo
- When a TweenData starts a yoyo. This happens after the hold
delay expires, if set.
onRepeat
- When a TweenData repeats playback. This happens after the repeatDelay
expires, if set.
onUpdate
- When a TweenData updates a property on a source target during playback.
name | type | arguments | description |
---|---|---|---|
type | Phaser.Types.Tweens.TweenCallbackTypes |
The type of callback to set. One of: |
|
callback | function |
Your callback that will be invoked. |
|
params | array | <optional> |
The parameters to pass to the callback. Pass an empty array if you don't want to define any, but do wish to set the scope. |
This Tween instance.