Filter
The TweenFrameData is a class that contains a single target that will change the texture frame at the conclusion of the Tween.
TweenFrameData instances are typically created by the TweenBuilder automatically, when it detects the prescence of a 'texture' property as the key being tweened.
A Tween can own multiple TweenFrameData instances, but a TweenFrameData only ever belongs to a single Tween.
You should not typically create these yourself, but rather use the TweenBuilder,
or the Tween.addFrame method.
Constructor:
new TweenFrameData(tween, targetIndex, texture, frame, delay, duration, hold, repeat, repeatDelay, flipX, flipY)
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. |
| texture | string |
The texture key to set at the end of this tween. |
| frame | string | number |
The texture frame to set at the end of this tween. |
| delay | function |
Function that returns the time in milliseconds before tween will start. |
| duration | number |
The duration of the tween in milliseconds. |
| 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? |
Extends
Members
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 amount of time, in milliseconds, that has elapsed since this TweenData was made active.
Type:
Description:
The frame to be set at the end of the tween.
Type:
Description:
The texture to be set at the end of the tween.
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:
This function returns the value to be used for TweenData.delay.
Type:
Description:
The time, in milliseconds, before this tween will start a yoyo to repeat.
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.
Always 'texture' for a TweenFrameData object.
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 frame to be set at the start of the tween.
Type:
Description:
The texture to be set at the start of the tween.
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