Phaser API Documentation

  Version: 

Description:

An object containing the different Tween callback functions.

You can either set these in the Tween config, or by calling the Tween.setCallback method.

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.

Since: 3.60.0