Filter
The TweenData is a class that contains a single target and property that is being tweened.
Tweens create TweenData instances when they are created, with one TweenData instance per target, per property. A Tween can own multiple TweenData instances, but a TweenData only ever belongs to a single Tween.
You should not typically create these yourself, but rather use the TweenBuilder,
or the Tween.add method.
Prior to Phaser 3.60 the TweenData was just an object, but was refactored to a class, to make it responsible for its own state and updating.
Constructor:
new TweenData(tween, targetIndex, key, getEnd, getStart, getActive, ease, delay, duration, yoyo, hold, repeat, repeatDelay, flipX, flipY, interpolation, interpolationData)
Parameters:
| name | type | description |
|---|---|---|
| tween | Phaser.Tweens.Tween |
The tween this TweenData instance belongs to. |
| targetIndex | number |
The target index within the Tween targets array. |
| key | string |
The property of the target to tween. |
| getEnd | Phaser.Types.Tweens.GetEndCallback |
What the property will be at the END of the Tween. |
| getStart | Phaser.Types.Tweens.GetStartCallback |
What the property will be at the START of the Tween. |
| getActive | Phaser.Types.Tweens.GetActiveCallback |
If not null, is invoked immediately as soon as the TweenData is running, and is set on the target property. |
| ease | function |
The ease function this tween uses. |
| delay | function |
Function that returns the time in milliseconds before tween will start. |
| duration | number |
The duration of the tween in milliseconds. |
| yoyo | boolean |
Determines whether the tween should return back to its start value after hold has expired. |
| hold | number |
Function that returns the time in milliseconds the tween will pause before repeating or returning to its starting value if yoyo is set to true. |
| repeat | number |
Function that returns the number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice. |
| repeatDelay | number |
Function that returns the time in milliseconds before the repeat will start. |
| flipX | boolean |
Should toggleFlipX be called when yoyo or repeat happens? |
| flipY | boolean |
Should toggleFlipY be called when yoyo or repeat happens? |
| interpolation | function |
The interpolation function to be used for arrays of data. Defaults to 'null'. |
| interpolationData | Array.<number> |
The array of interpolation data to be set. Defaults to 'null'. |
Extends
Members
Description:
The targets current value, as recorded in the most recent step.
Type:
Description:
The time, in milliseconds, before this tween will start playing.
This value is generated by the getDelay function.
Type:
Description:
The duration of the tween in milliseconds, excluding any time required for yoyo or repeats.
Type:
Description:
The ease function this Tween uses to calculate the target value.
Type:
Description:
The amount of time, in milliseconds, that has elapsed since this TweenData was made active.
Type:
Description:
The targets ending value, as returned by getEndValue.
Type:
Description:
If true this Tween will call toggleFlipX on the Tween target
whenever it yoyo's or repeats. It will only be called if the target
has a function matching this name, like most Phaser GameObjects do.
Type:
Description:
If true this Tween will call toggleFlipY on the Tween target
whenever it yoyo's or repeats. It will only be called if the target
has a function matching this name, like most Phaser GameObjects do.
Type:
Description:
A function that returns what to set the target property to, the moment the TweenData is invoked.
This is called when this TweenData is initialised or reset.
Description:
This function returns the value to be used for TweenData.delay.
Type:
Description:
A function that returns what to set the target property to at the end of the tween.
This is called when the tween starts playing, after any initial start delay, or if the tween is reset, or is set to repeat.
Description:
A function that returns what to set the target property to at the start of the tween.
This is called when the tween starts playing, after any initial start delay, or if the tween is reset, or is set to repeat.
Description:
The time, in milliseconds, before this tween will start a yoyo to repeat.
Type:
Description:
The interpolation function to be used for arrays of data.
Type:
Description:
The array of data to interpolate, if interpolation is being used.
Type:
Description:
Is this Tween Data currently waiting for a countdown to elapse, or not?
Type:
Description:
The property of the target to be tweened.
Type:
Description:
The target value from the previous step.
Type:
Description:
A value between 0 and 1 holding the progress of this TweenData.
Type:
Description:
The number of times this tween will repeat.
The tween will always run once regardless of this value, so a repeat value of '1' will play the tween twice: I.e. the original play-through and then it repeats that once (1).
If this value is set to -1 this tween will repeat forever.
Type:
Description:
How many repeats are left to run?
Type:
Description:
The time, in milliseconds, before the repeat will start.
Type:
Description:
The targets starting value, as returned by getStartValue.
Type:
Description:
The state of this TweenData.
Type:
Description:
The index of the target within the Tween targets array.
Type:
Description:
The total calculated duration, in milliseconds, of this TweenData. Factoring in the duration, repeats, delays and yoyos.
Type:
Description:
A reference to the Tween that this TweenData instance belongs to.
Type:
Description:
Will the Tween ease back to its starting values, after reaching the end
and any hold value that may be set?
Type:
Methods
Description:
Immediately destroys this TweenData, nulling of all its references.
Description:
Internal method that will emit a TweenData based Event on the parent Tween and also invoke the given callback, if provided.
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:
Returns a reference to the target object belonging to this TweenData.
Returns:
Description:
The target object. Can be any JavaScript object, but is typically a Game Object.
Type:
- object
Description:
Returns true if this TweenData has a current state of COMPLETE, otherwise false.
Returns:
Description:
true if this TweenData has a current state of COMPLETE, otherwise false.
Type:
- boolean
Description:
Returns true if this TweenData has a current state of CREATED, otherwise false.
Returns:
Description:
true if this TweenData has a current state of CREATED, otherwise false.
Type:
- boolean
Description:
Returns true if this TweenData has a current state of DELAY, otherwise false.
Returns:
Description:
true if this TweenData has a current state of DELAY, otherwise false.
Type:
- boolean
Description:
Returns true if this TweenData has a current state of HOLD_DELAY, otherwise false.
Returns:
Description:
true if this TweenData has a current state of HOLD_DELAY, otherwise false.
Type:
- boolean
Description:
Returns true if this TweenData has a current state of PENDING_RENDER, otherwise false.
Returns:
Description:
true if this TweenData has a current state of PENDING_RENDER, otherwise false.
Type:
- boolean
Description:
Returns true if this TweenData has a current state of PLAYING_BACKWARD, otherwise false.
Returns:
Description:
true if this TweenData has a current state of PLAYING_BACKWARD, otherwise false.
Type:
- boolean
Description:
Returns true if this TweenData has a current state of PLAYING_FORWARD, otherwise false.
Returns:
Description:
true if this TweenData has a current state of PLAYING_FORWARD, otherwise false.
Type:
- boolean
Description:
Returns true if this TweenData has a current state of REPEAT_DELAY, otherwise false.
Returns:
Description:
true if this TweenData has a current state of REPEAT_DELAY, otherwise false.
Type:
- boolean
Description:
Internal method that handles repeating or yoyo'ing this TweenData.
Called automatically by setStateFromStart and setStateFromEnd.
Parameters:
| name | type | description |
|---|---|---|
| diff | number |
Any extra time that needs to be accounted for in the elapsed and progress values. |
| setStart | boolean |
Set the TweenData start values? |
| isYoyo | boolean |
Is this call a Yoyo check? |
Description:
Internal method that resets this Tween Data entirely, including the progress and elapsed values.
Called automatically by the parent Tween. Should not be called directly.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| isSeeking | boolean | <optional> | false |
Is the Tween Data being reset as part of a Tween seek? |
Description:
Sets this TweenData state to COMPLETE.
Description:
Sets this TweenData state to CREATED.
Description:
Sets this TweenData state to DELAY.
Description:
Sets this TweenData state to HOLD_DELAY.
Description:
Sets this TweenData state to PENDING_RENDER.
Description:
Sets this TweenData state to PLAYING_BACKWARD.
Description:
Sets this TweenData state to PLAYING_FORWARD.
Description:
Sets this TweenData state to REPEAT_DELAY.
Description:
Internal method used as part of the playback process that checks if this TweenData should yoyo, repeat, or has completed.
Parameters:
| name | type | description |
|---|---|---|
| diff | number |
Any extra time that needs to be accounted for in the elapsed and progress values. |
Description:
Internal method used as part of the playback process that checks if this TweenData should repeat or has completed.
Parameters:
| name | type | description |
|---|---|---|
| diff | number |
Any extra time that needs to be accounted for in the elapsed and progress values. |
Description:
Sets this TweenData's target object property to be the given value.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| value | number | <optional> |
The value to set on the target. If not given, sets it to the last |
Description:
Internal method that advances this TweenData based on the delta value given.
Parameters:
| name | type | description |
|---|---|---|
| delta | number |
The elapsed delta time in ms. |
Returns:
Description:
true if this TweenData is still playing, or false if it has finished entirely.
Type:
- boolean