Filter
Phaser . Tweens . TweenChain
Phaser . Tweens . TweenChain
A TweenChain is a special type of Tween that allows you to create a sequence of Tweens, chained to one-another, and add them to the Tween Manager.
The tweens are played in order, from start to finish. You can optionally set the chain to repeat as many times as you like. Once the chain has finished playing, or repeating if set, all tweens in the chain will be destroyed automatically. To override this, set the 'persists' argument to 'true'.
Playback will start immediately unless the first Tween has been configured to be paused.
Please note that Tweens will not manipulate any target property that begins with an underscore.
Constructor:
new TweenChain(parent)
Parameters:
| name | type | description |
|---|---|---|
| parent | Phaser.Tweens.TweenManager | Phaser.Tweens.TweenChain |
A reference to the Tween Manager, or TweenChain, that owns this TweenChain. |
Extends
Members
Description:
The scope (or context) in which all of the callbacks are invoked.
This defaults to be this Tween, but you can override this property to set it to whatever object you require.
Type:
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.
Description:
The time in milliseconds before the 'onComplete' event fires.
This never fires if loop = -1 as it never completes because it has been
set to loop forever.
Type:
Description:
An internal countdown timer (used by loopDelay and completeDelay)
Type:
Description:
A reference to the data array index of the currently playing tween.
Type:
Description:
A reference to the Tween that this TweenChain is currently playing.
Type:
Description:
The main data array. For a Tween, this contains all of the TweenData objects, each
containing a unique property and target that is being tweened.
For a TweenChain, this contains an array of Tween instances, which are being played
through in sequence.
Type:
Description:
Has this Tween started playback yet?
This boolean is toggled when the Tween leaves the 'start delayed' state and begins running.
Type:
Description:
The number of times this Tween will loop.
Can be -1 for an infinite loop, zero for none, or a positive integer.
Typically this is set in the configuration object, but can also be set directly as long as this Tween is paused and hasn't started playback.
When enabled it will play through ALL Tweens again.
Use TweenData.repeat to loop a single element.
Type:
Description:
Internal counter recording how many loops are left to run.
Type:
Description:
The time in milliseconds before the Tween loops.
Only used if loop is > 0.
Type:
Description:
A reference to the Tween Manager, or Tween Chain, that owns this Tween.
Description:
Is the Tween currently paused?
A paused Tween needs to be started with the play method, or resumed with the resume method.
This property can be toggled at runtime if required.
Type:
Description:
Will this Tween persist after playback? A Tween that persists will not be destroyed by the
Tween Manager, or when calling Tween.stop, and can be re-played as required. You can either
set this property when creating the tween in the tween config, or set it prior to playback.
However, it's up to you to ensure you destroy persistent tweens when you are finished with them, or they will retain references you may no longer require and waste memory.
By default, Tweens are set to not persist, so they are automatically cleaned-up by
the Tween Manager. But TweenChains do persist by default, unless overridden in their
config. This is because the type of situations you use a chain for is far more likely to
need to be replayed again in the future, rather than disposed of.
Type:
Description:
The time in milliseconds before the 'onStart' event fires.
For a Tween, this is the shortest delay value across all of the TweenDatas it owns.
For a TweenChain, it is whatever delay value was given in the configuration.
Type:
Description:
The current state of the Tween.
Type:
Description:
Scales the time applied to this Tween. A value of 1 runs in real-time. A value of 0.5 runs 50% slower, and so on.
The value isn't used when calculating total duration of the tween, it's a run-time delta adjustment only.
This value is multiplied by the TweenManager.timeScale.
Type:
Description:
The cached size of the data array.
Type:
Methods
Description:
Create a sequence of Tweens, chained to one-another, and add them to this Tween Manager.
The tweens are played in order, from start to finish. You can optionally set the chain to repeat as many times as you like. Once the chain has finished playing, or repeating if set, all tweens in the chain will be destroyed automatically. To override this, set the 'persists' argument to 'true'.
Playback will start immediately unless the first Tween has been configured to be paused.
Please note that Tweens will not manipulate any target property that begins with an underscore.
Parameters:
| name | type | description |
|---|---|---|
| tweens | Array.<object> | Array.<Phaser.Types.Tweens.TweenBuilderConfig> |
An array of Tween configuration objects for the Tweens in this chain. |
Returns:
Description:
This TweenChain instance.
Type:
Description:
Add a listener for a given event.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| event | string | symbol |
The event name. |
||
| fn | function |
The listener function. |
||
| context | * | <optional> | this |
The context to invoke the listener with. |
Returns:
Description:
this.
Type:
Description:
Flags the Tween as being complete, whatever stage of progress it is at.
If an onComplete callback has been defined it will automatically invoke it, unless a delay
argument is provided, in which case the Tween will delay for that period of time before calling the callback.
If you don't need a delay or don't have an onComplete callback then call Tween.stop instead.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| delay | number | <optional> |
The time to wait before invoking the complete callback. If zero it will fire immediately. |
Returns:
Description:
This Tween instance.
Type:
Description:
Flags the Tween as being complete only once the current loop has finished.
This is a useful way to stop an infinitely looping tween once a complete cycle is over, rather than abruptly.
If you don't have a loop then call Tween.stop instead.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| loops | number | <optional> |
The number of loops that should finish before this tween completes. Zero means complete just the current loop. |
Returns:
Description:
This Tween instance.
Type:
Description:
Immediately destroys this TweenChain, nulling of all its references.
Description:
Internal method that will emit a TweenChain based Event and invoke the given callback.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | Phaser.Types.Tweens.Event |
The Event to be dispatched. |
|
| callback | Phaser.Types.Tweens.TweenCallbackTypes | <optional> |
The name of the callback to be invoked. Can be |
Description:
Calls each of the listeners registered for a given event.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | string | symbol |
The event name. |
|
| args | * | <optional> |
Additional arguments that will be passed to the event handler. |
Returns:
Description:
true if the event had listeners, else false.
Type:
- boolean
Description:
Return an array listing the events for which the emitter has registered listeners.
Type:
- Array.<(string
- symbol)>
Description:
Gets the value of the time scale applied to this Tween. A value of 1 runs in real-time. A value of 0.5 runs 50% slower, and so on.
Returns:
Description:
The value of the time scale applied to this Tween.
Type:
- number
Description:
See if any of the tweens in this Tween Chain is currently acting upon the given target.
Parameters:
| name | type | description |
|---|---|---|
| target | object |
The target to check against this TweenChain. |
Returns:
Description:
true if the given target is a target of this TweenChain, otherwise false.
Type:
- boolean
Description:
Prepares this TweenChain for playback.
Called automatically by the TweenManager. Should not be called directly.
Returns:
Description:
This TweenChain instance.
Type:
Description:
Returns true if this Tween has a current state of ACTIVE, otherwise false.
Returns:
Description:
true if this Tween has a current state of ACTIVE, otherwise false.
Type:
- boolean
Description:
Returns true if this Tween has a current state of COMPLETE_DELAY, otherwise false.
Returns:
Description:
true if this Tween has a current state of COMPLETE_DELAY, otherwise false.
Type:
- boolean
Description:
Returns true if this Tween has a current state of DESTROYED, otherwise false.
Returns:
Description:
true if this Tween has a current state of DESTROYED, otherwise false.
Type:
- boolean
Description:
Returns true if this Tween has a current state of FINISHED, otherwise false.
Returns:
Description:
true if this Tween has a current state of FINISHED, otherwise false.
Type:
- boolean
Description:
Returns true if this Tween has a current state of LOOP_DELAY, otherwise false.
Returns:
Description:
true if this Tween has a current state of LOOP_DELAY, otherwise false.
Type:
- boolean
Description:
Checks if the Tween is currently paused.
This is the same as inspecting the BaseTween.paused property directly.
Returns:
Description:
true if the Tween is paused, otherwise false.
Type:
- boolean
Description:
Returns true if this Tween has a current state of PENDING, otherwise false.
Returns:
Description:
true if this Tween has a current state of PENDING, otherwise false.
Type:
- boolean
Description:
Returns true if this Tween has a current state of PENDING_REMOVE, otherwise false.
Returns:
Description:
true if this Tween has a current state of PENDING_REMOVE, otherwise false.
Type:
- boolean
Description:
Checks if this Tween is currently playing.
If this Tween is paused, or not active, this method will return false.
Returns:
Description:
true if the Tween is playing, otherwise false.
Type:
- boolean
Description:
Returns true if this Tween has a current state of REMOVED, otherwise false.
Returns:
Description:
true if this Tween has a current state of REMOVED, otherwise false.
Type:
- boolean
Description:
Returns true if this Tween has a current state of START_DELAY, otherwise false.
Returns:
Description:
true if this Tween has a current state of START_DELAY, otherwise false.
Type:
- boolean
Description:
Return the number of listeners listening to a given event.
Parameters:
| name | type | description |
|---|---|---|
| event | string | symbol |
The event name. |
Returns:
Description:
The number of listeners.
Type:
- number
Description:
Return the listeners registered for a given event.
Parameters:
| name | type | description |
|---|---|---|
| event | string | symbol |
The event name. |
Returns:
Description:
The registered listeners.
Type:
- Array.<function()>
Description:
Re-initiases the given Tween and sets it to the Active state.
Parameters:
| name | type | description |
|---|---|---|
| tween | Phaser.Tweens.Tween |
The Tween to check. |
Returns:
Description:
This TweenChain instance.
Type:
Description:
Internal method that advances to the next state of the TweenChain playback.
Returns:
Description:
true if this TweenChain has completed, otherwise false.
Type:
- boolean
Description:
Immediately advances to the next Tween in the chain.
This is typically called internally, but can be used if you need to advance playback for some reason.
Returns:
Description:
true if there are no more Tweens in the chain, otherwise false.
Type:
- boolean
Description:
Remove the listeners of a given event.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | string | symbol |
The event name. |
|
| fn | function | <optional> |
Only remove the listeners that match this function. |
| context | * | <optional> |
Only remove the listeners that have this context. |
| once | boolean | <optional> |
Only remove one-time listeners. |
Returns:
Description:
this.
Type:
Description:
Add a listener for a given event.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| event | string | symbol |
The event name. |
||
| fn | function |
The listener function. |
||
| context | * | <optional> | this |
The context to invoke the listener with. |
Returns:
Description:
this.
Type:
Description:
Internal method that handles this tween completing and emitting the onComplete event and callback.
Description:
Add a one-time listener for a given event.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| event | string | symbol |
The event name. |
||
| fn | function |
The listener function. |
||
| context | * | <optional> | this |
The context to invoke the listener with. |
Returns:
Description:
this.
Type:
Description:
Pauses the Tween immediately. Use resume to continue playback.
You can also toggle the Tween.paused boolean property, but doing so will not trigger the PAUSE event.
Returns:
Description:
This Tween instance.
Type:
Description:
Starts this TweenChain playing.
You only need to call this method if you have configured this TweenChain to be paused on creation.
If the TweenChain is already playing, calling this method again will have no effect. If you wish to
restart the chain, use TweenChain.restart instead.
Calling this method after the TweenChain has completed will start the chain playing again from the beginning.
Returns:
Description:
This TweenChain instance.
Type:
Description:
Removes the given Tween from this Tween Chain.
The removed tween is not destroyed. It is just removed from this Tween Chain.
If the given Tween is currently playing then the chain will automatically move to the next tween in the chain. If there are no more tweens, this chain will complete.
Parameters:
| name | type | description |
|---|---|---|
| tween | Phaser.Tweens.Tween |
The Tween to be removed. |
Returns:
Description:
This Tween Chain instance.
Type:
Description:
Remove all listeners, or those of the specified event.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | string | symbol | <optional> |
The event name. |
Returns:
Description:
this.
Type:
Description:
Remove the listeners of a given event.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | string | symbol |
The event name. |
|
| fn | function | <optional> |
Only remove the listeners that match this function. |
| context | * | <optional> |
Only remove the listeners that have this context. |
| once | boolean | <optional> |
Only remove one-time listeners. |
Returns:
Description:
this.
Type:
Description:
Resets the given Tween.
It will seek to position 0 and playback will start on the next frame.
Parameters:
| name | type | description |
|---|---|---|
| tween | Phaser.Tweens.Tween |
The Tween to be reset. |
Returns:
Description:
This TweenChain instance.
Type:
Description:
Internal method that resets all of the Tweens and the current index pointer.
Description:
Restarts the TweenChain from the beginning.
If this TweenChain was configured to have a loop, or start delay, those
are reset to their initial values as well. It will also dispatch the
onActive callback and event again.
Returns:
Description:
This TweenChain instance.
Type:
Description:
Resumes the playback of a previously paused Tween.
You can also toggle the Tween.paused boolean property, but doing so will not trigger the RESUME event.
Returns:
Description:
This Tween instance.
Type:
Description:
Sets this Tween state to ACTIVE.
Description:
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.
Parameters:
| 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. |
Returns:
Description:
This Tween instance.
Type:
Description:
Sets this Tween state to COMPLETE_DELAY.
Description:
Sets the current active Tween to the given index, based on its entry in the TweenChain data array.
Parameters:
| name | type | description |
|---|---|---|
| index | number |
The index of the Tween to be made current. |
Description:
Sets this Tween state to DESTROYED.
Description:
Sets this Tween state to FINISHED.
Description:
Sets this Tween state to LOOP_DELAY.
Description:
Sets this Tween state to PENDING_REMOVE.
Description:
Sets this Tween state to PENDING.
Description:
Sets this Tween state to REMOVED.
Description:
Sets this Tween state to START_DELAY.
Description:
Sets the value of the time scale applied to this Tween. A value of 1 runs in real-time. A value of 0.5 runs 50% slower, and so on.
The value isn't used when calculating total duration of the tween, it's a run-time delta adjustment only.
This value is multiplied by the TweenManager.timeScale.
Parameters:
| name | type | description |
|---|---|---|
| value | number |
The time scale value to set. |
Returns:
Description:
This Tween instance.
Type:
Description:
Removes all listeners.
Description:
Stops the Tween immediately, whatever stage of progress it is at.
If not a part of a Tween Chain it is also flagged for removal by the Tween Manager.
If an onStop callback has been defined it will automatically invoke it.
The Tween will be removed during the next game frame, but should be considered 'destroyed' from this point on.
Typically, you cannot play a Tween that has been stopped. If you just wish to pause the tween, not destroy it,
then call the pause method instead and use resume to continue playback. If you wish to restart the Tween,
use the restart or seek methods.
Returns:
Description:
This Tween instance.
Type:
Description:
Internal method that advances the TweenChain based on the time values.
Parameters:
| name | type | description |
|---|---|---|
| delta | number |
The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate. |
Returns:
Description:
Returns true if this TweenChain has finished and should be removed from the Tween Manager, otherwise returns false.
Type:
- boolean
Fires:
Description:
Internal method that handles the processing of the complete delay countdown timer and
the dispatch of related events. Called automatically by Tween.update.
Parameters:
| name | type | description |
|---|---|---|
| delta | number |
The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate. |
Description:
Internal method that handles the processing of the loop delay countdown timer and
the dispatch of related events. Called automatically by Tween.update.
Parameters:
| name | type | description |
|---|---|---|
| delta | number |
The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate. |
Description:
Internal method that handles the processing of the start delay countdown timer and
the dispatch of related events. Called automatically by Tween.update.
Parameters:
| name | type | description |
|---|---|---|
| delta | number |
The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate. |