Phaser.Tweens.Tween

A Tween is able to manipulate the properties of one or more objects to any given value, based on a duration and type of ease. They are rarely instantiated directly and instead should be created via the TweenManager.

Please note that a Tween will not manipulate any property that begins with an underscore.

Constructor

new Tween(parent, targets)

Parameters:

nametypeoptionaldescription
parentPhaser.Tweens.TweenManagerNoA reference to the Tween Manager that owns this Tween.
targetsArray.<object>NoAn array of targets to be tweened.

Scope: static

Extends: Phaser.Tweens.BaseTween

Source: src/tweens/tween/Tween.js - Line: 17
Since: 3.0.0

Members:

callbacks: Phaser.Types.Tweens.TweenCallbacks

callbacks

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.

Inherits: Phaser.Tweens.BaseTween#callbacks

Source: src/tweens/tween/BaseTween.js - Line: 195
Since: 3.60.0


callbackScope: any

callbackScope

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.

Inherits: Phaser.Tweens.BaseTween#callbackScope

Source: src/tweens/tween/BaseTween.js - Line: 233
Since: 3.60.0


completeDelay: number

completeDelay

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.

Inherits: Phaser.Tweens.BaseTween#completeDelay

Source: src/tweens/tween/BaseTween.js - Line: 149
Since: 3.60.0


countdown: number

countdown

Description:

An internal countdown timer (used by loopDelay and completeDelay)

Inherits: Phaser.Tweens.BaseTween#countdown

Source: src/tweens/tween/BaseTween.js - Line: 162
Since: 3.60.0


data: Array.<Phaser.Tweens.TweenData>, Array.<Phaser.Tweens.Tween>

data

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.

Inherits: Phaser.Tweens.BaseTween#data

Source: src/tweens/tween/BaseTween.js - Line: 47
Since: 3.60.0


duration: number

duration

Description:

Time in milliseconds for the whole Tween to play through once, excluding loop amounts and loop delays.

This value is set in the Tween.initTweenData method and is zero before that point.

Source: src/tweens/tween/Tween.js - Line: 112
Since: 3.60.0


elapsed: number

elapsed

Description:

Elapsed time in milliseconds of this run through of the Tween.

Source: src/tweens/tween/Tween.js - Line: 92
Since: 3.60.0


hasStarted: boolean

hasStarted

Description:

Has this Tween started playback yet?

This boolean is toggled when the Tween leaves the 'start delayed' state and begins running.

Inherits: Phaser.Tweens.BaseTween#hasStarted

Source: src/tweens/tween/BaseTween.js - Line: 82
Since: 3.60.0


isInfinite: boolean

isInfinite

Description:

Does this Tween loop or repeat infinitely?

Source: src/tweens/tween/Tween.js - Line: 82
Since: 3.60.0


isSeeking: boolean

isSeeking

Description:

Is this Tween currently seeking?

This boolean is toggled in the Tween.seek method.

When a tween is seeking, by default it will not dispatch any events or callbacks.

Source: src/tweens/tween/Tween.js - Line: 68
Since: 3.19.0


loop: number

loop

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.

Inherits: Phaser.Tweens.BaseTween#loop

Source: src/tweens/tween/BaseTween.js - Line: 108
Since: 3.60.0


loopCounter: number

loopCounter

Description:

Internal counter recording how many loops are left to run.

Inherits: Phaser.Tweens.BaseTween#loopCounter

Source: src/tweens/tween/BaseTween.js - Line: 139
Since: 3.60.0


loopDelay: number

loopDelay

Description:

The time in milliseconds before the Tween loops.

Only used if loop is > 0.

Inherits: Phaser.Tweens.BaseTween#loopDelay

Source: src/tweens/tween/BaseTween.js - Line: 127
Since: 3.60.0


parent: Phaser.Tweens.TweenManager, Phaser.Tweens.TweenChain

parent

Description:

A reference to the Tween Manager, or Tween Chain, that owns this Tween.

Inherits: Phaser.Tweens.BaseTween#parent

Source: src/tweens/tween/BaseTween.js - Line: 38
Since: 3.60.0


paused: boolean

paused

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.

Inherits: Phaser.Tweens.BaseTween#paused

Source: src/tweens/tween/BaseTween.js - Line: 181
Since: 3.60.0


persist: boolean

persist

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.

Inherits: Phaser.Tweens.BaseTween#persist

Source: src/tweens/tween/BaseTween.js - Line: 245
Since: 3.60.0


progress: number

progress

Description:

Value between 0 and 1. The amount of progress through the Tween, excluding loops.

Source: src/tweens/tween/Tween.js - Line: 124
Since: 3.60.0


startDelay: number

startDelay

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.

Inherits: Phaser.Tweens.BaseTween#startDelay

Source: src/tweens/tween/BaseTween.js - Line: 69
Since: 3.60.0


state: Phaser.Tweens.StateType

state

Description:

The current state of the Tween.

Inherits: Phaser.Tweens.BaseTween#state

Source: src/tweens/tween/BaseTween.js - Line: 172
Since: 3.60.0


targets: Array.<object>

targets

Description:

An array of references to the target/s this Tween is operating on.

This array should not be manipulated outside of this Tween.

Source: src/tweens/tween/Tween.js - Line: 44
Since: 3.0.0


timeScale: number

timeScale

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.

Inherits: Phaser.Tweens.BaseTween#timeScale

Source: src/tweens/tween/BaseTween.js - Line: 94
Since: 3.60.0


totalData: number

totalData

Description:

The cached size of the data array.

Inherits: Phaser.Tweens.BaseTween#totalData

Source: src/tweens/tween/BaseTween.js - Line: 60
Since: 3.60.0


totalDuration: number

totalDuration

Description:

Time in milliseconds it takes for the Tween to complete a full playthrough (including looping)

For an infinite Tween, this value is a very large integer.

Source: src/tweens/tween/Tween.js - Line: 134
Since: 3.60.0


totalElapsed: number

totalElapsed

Description:

Total elapsed time in milliseconds of the entire Tween, including looping.

Source: src/tweens/tween/Tween.js - Line: 102
Since: 3.60.0


totalProgress: number

totalProgress

Description:

The amount of progress that has been made through the entire Tween, including looping.

A value between 0 and 1.

Source: src/tweens/tween/Tween.js - Line: 146
Since: 3.60.0


totalTargets: number

totalTargets

Description:

Cached target total.

Used internally and should be treated as read-only.

This is not necessarily the same as the data total.

Source: src/tweens/tween/Tween.js - Line: 55
Since: 3.0.0


Methods:

add

<instance> add(targetIndex, key, getEnd, getStart, getActive, ease, delay, duration, yoyo, hold, repeat, repeatDelay, flipX, flipY, interpolation, interpolationData)

Description:

Adds a new TweenData to this Tween. Typically, this method is called automatically by the TweenBuilder, however you can also invoke it yourself.

Parameters:

nametypeoptionaldescription
targetIndexnumberNoThe target index within the Tween targets array.
keystringNoThe property of the target to tween.
getEndPhaser.Types.Tweens.GetEndCallbackNoWhat the property will be at the END of the Tween.
getStartPhaser.Types.Tweens.GetStartCallbackNoWhat the property will be at the START of the Tween.
getActivePhaser.Types.Tweens.GetActiveCallbackNoIf not null, is invoked immediately as soon as the TweenData is running, and is set on the target property.
easefunctionNoThe ease function this tween uses.
delayfunctionNoFunction that returns the time in milliseconds before tween will start.
durationnumberNoThe duration of the tween in milliseconds.
yoyobooleanNoDetermines whether the tween should return back to its start value after hold has expired.
holdnumberNoFunction that returns the time in milliseconds the tween will pause before repeating or returning to its starting value if yoyo is set to true.
repeatnumberNoFunction 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.
repeatDelaynumberNoFunction that returns the time in milliseconds before the repeat will start.
flipXbooleanNoShould toggleFlipX be called when yoyo or repeat happens?
flipYbooleanNoShould toggleFlipY be called when yoyo or repeat happens?
interpolationfunctionNoThe interpolation function to be used for arrays of data. Defaults to 'null'.
interpolationDataArray.<number>NoThe array of interpolation data to be set. Defaults to 'null'.

Returns: Phaser.Tweens.TweenData - The TweenData instance that was added.

Source: src/tweens/tween/Tween.js - Line: 159
Since: 3.60.0


addFrame

<instance> addFrame(targetIndex, texture, frame, delay, duration, hold, repeat, repeatDelay, flipX, flipY)

Description:

Adds a new TweenFrameData to this Tween. Typically, this method is called automatically by the TweenBuilder, however you can also invoke it yourself.

Parameters:

nametypeoptionaldescription
targetIndexnumberNoThe target index within the Tween targets array.
texturestringNoThe texture to set on the target at the end of the tween.
framestring | numberNoThe texture frame to set on the target at the end of the tween.
delayfunctionNoFunction that returns the time in milliseconds before tween will start.
durationnumberNoThe duration of the tween in milliseconds.
holdnumberNoFunction that returns the time in milliseconds the tween will pause before repeating or returning to its starting value if yoyo is set to true.
repeatnumberNoFunction 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.
repeatDelaynumberNoFunction that returns the time in milliseconds before the repeat will start.
flipXbooleanNoShould toggleFlipX be called when yoyo or repeat happens?
flipYbooleanNoShould toggleFlipY be called when yoyo or repeat happens?

Returns: Phaser.Tweens.TweenFrameData - The TweenFrameData instance that was added.

Source: src/tweens/tween/Tween.js - Line: 195
Since: 3.60.0


addListener

<instance> addListener(event, fn, [context])

Description:

Add a listener for a given event.

Parameters:

nametypeoptionaldefaultdescription
eventstring | symbolNoThe event name.
fnfunctionNoThe listener function.
context*Yes"this"The context to invoke the listener with.

Returns: Phaser.Tweens.Tween - this.

Inherits: Phaser.Events.EventEmitter#addListener

Source: src/events/EventEmitter.js - Line: 111
Since: 3.0.0


complete

<instance> complete([delay])

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:

nametypeoptionaldefaultdescription
delaynumberYes0The time to wait before invoking the complete callback. If zero it will fire immediately.

Returns: Phaser.Tweens.Tween - This Tween instance.

Fires: Phaser.Tweens.Events#event:TWEEN_COMPLETE

Inherits: Phaser.Tweens.BaseTween#complete

Source: src/tweens/tween/BaseTween.js - Line: 404
Since: 3.2.0


completeAfterLoop

<instance> completeAfterLoop([loops])

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:

nametypeoptionaldefaultdescription
loopsnumberYes0The number of loops that should finish before this tween completes. Zero means complete just the current loop.

Returns: Phaser.Tweens.Tween - This Tween instance.

Fires: Phaser.Tweens.Events#event:TWEEN_COMPLETE

Inherits: Phaser.Tweens.BaseTween#completeAfterLoop

Source: src/tweens/tween/BaseTween.js - Line: 438
Since: 3.60.0


destroy

<instance> destroy()

Description:

Handles the destroy process of this Tween, clearing out the Tween Data and resetting the targets. A Tween that has been destroyed cannot ever be played or used again.

Overrides: Phaser.Tweens.BaseTween#destroy

Source: src/tweens/tween/Tween.js - Line: 794
Since: 3.60.0


dispatchEvent

<instance> dispatchEvent(event, [callback])

Description:

Internal method that will emit a Tween based Event and invoke the given callback.

Parameters:

nametypeoptionaldescription
eventPhaser.Types.Tweens.EventNoThe Event to be dispatched.
callbackPhaser.Types.Tweens.TweenCallbackTypesYesThe name of the callback to be invoked. Can be null or undefined to skip invocation.

Source: src/tweens/tween/Tween.js - Line: 770
Since: 3.60.0


emit

<instance> emit(event, [args])

Description:

Calls each of the listeners registered for a given event.

Parameters:

nametypeoptionaldescription
eventstring | symbolNoThe event name.
args*YesAdditional arguments that will be passed to the event handler.

Returns: boolean - true if the event had listeners, else false.

Inherits: Phaser.Events.EventEmitter#emit

Source: src/events/EventEmitter.js - Line: 86
Since: 3.0.0


eventNames

<instance> eventNames()

Description:

Return an array listing the events for which the emitter has registered listeners.

Returns: Array.<(string | symbol)> - undefined

Inherits: Phaser.Events.EventEmitter#eventNames

Source: src/events/EventEmitter.js - Line: 55
Since: 3.0.0


forward

<instance> forward(ms)

Description:

Moves this Tween forward by the given amount of milliseconds.

It will only advance through the current loop of the Tween. For example, if the Tween is set to repeat or yoyo, it can only fast forward through a single section of the sequence. Use Tween.seek for more complex playhead control.

If the Tween is paused or has already finished, calling this will have no effect.

Parameters:

nametypeoptionaldescription
msnumberNoThe number of milliseconds to advance this Tween by.

Returns: Phaser.Tweens.Tween - This Tween instance.

Source: src/tweens/tween/Tween.js - Line: 724
Since: 3.60.0


getTimeScale

<instance> getTimeScale()

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: number - The value of the time scale applied to this Tween.

Inherits: Phaser.Tweens.BaseTween#getTimeScale

Source: src/tweens/tween/BaseTween.js - Line: 285
Since: 3.60.0


getValue

<instance> getValue([index])

Description:

Returns the current value of the specified Tween Data.

If this Tween has been destroyed, it will return null.

Parameters:

nametypeoptionaldefaultdescription
indexnumberYes0The Tween Data to return the value from.

Returns: number - The value of the requested Tween Data, or null if this Tween has been destroyed.

Source: src/tweens/tween/Tween.js - Line: 225
Since: 3.0.0


hasTarget

<instance> hasTarget(target)

Description:

See if this Tween is currently acting upon the given target.

Parameters:

nametypeoptionaldescription
targetobjectNoThe target to check against this Tween.

Returns: boolean - true if the given target is a target of this Tween, otherwise false.

Source: src/tweens/tween/Tween.js - Line: 251
Since: 3.0.0


initTweenData

<instance> initTweenData([isSeeking])

Description:

Initialises all of the Tween Data and Tween values.

This is called automatically and should not typically be invoked directly.

Parameters:

nametypeoptionaldefaultdescription
isSeekingbooleanYesfalseIs the Tween Data being reset as part of a seek?

Source: src/tweens/tween/Tween.js - Line: 543
Since: 3.60.0


isActive

<instance> isActive()

Description:

Returns true if this Tween has a current state of ACTIVE, otherwise false.

Returns: boolean - true if this Tween has a current state of ACTIVE, otherwise false.

Inherits: Phaser.Tweens.BaseTween#isActive

Source: src/tweens/tween/BaseTween.js - Line: 747
Since: 3.60.0


isCompleteDelayed

<instance> isCompleteDelayed()

Description:

Returns true if this Tween has a current state of COMPLETE_DELAY, otherwise false.

Returns: boolean - true if this Tween has a current state of COMPLETE_DELAY, otherwise false.

Inherits: Phaser.Tweens.BaseTween#isCompleteDelayed

Source: src/tweens/tween/BaseTween.js - Line: 773
Since: 3.60.0


isDestroyed

<instance> isDestroyed()

Description:

Returns true if this Tween has a current state of DESTROYED, otherwise false.

Returns: boolean - true if this Tween has a current state of DESTROYED, otherwise false.

Inherits: Phaser.Tweens.BaseTween#isDestroyed

Source: src/tweens/tween/BaseTween.js - Line: 838
Since: 3.60.0


isFinished

<instance> isFinished()

Description:

Returns true if this Tween has a current state of FINISHED, otherwise false.

Returns: boolean - true if this Tween has a current state of FINISHED, otherwise false.

Inherits: Phaser.Tweens.BaseTween#isFinished

Source: src/tweens/tween/BaseTween.js - Line: 825
Since: 3.60.0


isLoopDelayed

<instance> isLoopDelayed()

Description:

Returns true if this Tween has a current state of LOOP_DELAY, otherwise false.

Returns: boolean - true if this Tween has a current state of LOOP_DELAY, otherwise false.

Inherits: Phaser.Tweens.BaseTween#isLoopDelayed

Source: src/tweens/tween/BaseTween.js - Line: 760
Since: 3.60.0


isPaused

<instance> isPaused()

Description:

Checks if the Tween is currently paused.

This is the same as inspecting the BaseTween.paused property directly.

Returns: boolean - true if the Tween is paused, otherwise false.

Inherits: Phaser.Tweens.BaseTween#isPaused

Source: src/tweens/tween/BaseTween.js - Line: 314
Since: 3.60.0


isPending

<instance> isPending()

Description:

Returns true if this Tween has a current state of PENDING, otherwise false.

Returns: boolean - true if this Tween has a current state of PENDING, otherwise false.

Inherits: Phaser.Tweens.BaseTween#isPending

Source: src/tweens/tween/BaseTween.js - Line: 734
Since: 3.60.0


isPendingRemove

<instance> isPendingRemove()

Description:

Returns true if this Tween has a current state of PENDING_REMOVE, otherwise false.

Returns: boolean - true if this Tween has a current state of PENDING_REMOVE, otherwise false.

Inherits: Phaser.Tweens.BaseTween#isPendingRemove

Source: src/tweens/tween/BaseTween.js - Line: 799
Since: 3.60.0


isPlaying

<instance> isPlaying()

Description:

Checks if this Tween is currently playing.

If this Tween is paused, or not active, this method will return false.

Returns: boolean - true if the Tween is playing, otherwise false.

Inherits: Phaser.Tweens.BaseTween#isPlaying

Source: src/tweens/tween/BaseTween.js - Line: 299
Since: 3.60.0


isRemoved

<instance> isRemoved()

Description:

Returns true if this Tween has a current state of REMOVED, otherwise false.

Returns: boolean - true if this Tween has a current state of REMOVED, otherwise false.

Inherits: Phaser.Tweens.BaseTween#isRemoved

Source: src/tweens/tween/BaseTween.js - Line: 812
Since: 3.60.0


isStartDelayed

<instance> isStartDelayed()

Description:

Returns true if this Tween has a current state of START_DELAY, otherwise false.

Returns: boolean - true if this Tween has a current state of START_DELAY, otherwise false.

Inherits: Phaser.Tweens.BaseTween#isStartDelayed

Source: src/tweens/tween/BaseTween.js - Line: 786
Since: 3.60.0


listenerCount

<instance> listenerCount(event)

Description:

Return the number of listeners listening to a given event.

Parameters:

nametypeoptionaldescription
eventstring | symbolNoThe event name.

Returns: number - The number of listeners.

Inherits: Phaser.Events.EventEmitter#listenerCount

Source: src/events/EventEmitter.js - Line: 75
Since: 3.0.0


listeners

<instance> listeners(event)

Description:

Return the listeners registered for a given event.

Parameters:

nametypeoptionaldescription
eventstring | symbolNoThe event name.

Returns: Array.<function()> - The registered listeners.

Inherits: Phaser.Events.EventEmitter#listeners

Source: src/events/EventEmitter.js - Line: 64
Since: 3.0.0


makeActive

<instance> makeActive()

Description:

Internal method that makes this Tween active within the TweenManager and emits the onActive event and callback.

Fires: Phaser.Tweens.Events#event:TWEEN_ACTIVE

Inherits: Phaser.Tweens.BaseTween#makeActive

Source: src/tweens/tween/BaseTween.js - Line: 375
Since: 3.60.0


nextState

<instance> nextState()

Description:

Internal method that advances to the next state of the Tween during playback.

Returns: boolean - true if this Tween has completed, otherwise false.

Fires: Phaser.Tweens.Events#event:TWEEN_COMPLETE, Phaser.Tweens.Events#event:TWEEN_LOOP

Source: src/tweens/tween/Tween.js - Line: 355
Since: 3.0.0


off

<instance> off(event, [fn], [context], [once])

Description:

Remove the listeners of a given event.

Parameters:

nametypeoptionaldescription
eventstring | symbolNoThe event name.
fnfunctionYesOnly remove the listeners that match this function.
context*YesOnly remove the listeners that have this context.
oncebooleanYesOnly remove one-time listeners.

Returns: Phaser.Tweens.Tween - this.

Inherits: Phaser.Events.EventEmitter#off

Source: src/events/EventEmitter.js - Line: 151
Since: 3.0.0


on

<instance> on(event, fn, [context])

Description:

Add a listener for a given event.

Parameters:

nametypeoptionaldefaultdescription
eventstring | symbolNoThe event name.
fnfunctionNoThe listener function.
context*Yes"this"The context to invoke the listener with.

Returns: Phaser.Tweens.Tween - this.

Inherits: Phaser.Events.EventEmitter#on

Source: src/events/EventEmitter.js - Line: 98
Since: 3.0.0


once

<instance> once(event, fn, [context])

Description:

Add a one-time listener for a given event.

Parameters:

nametypeoptionaldefaultdescription
eventstring | symbolNoThe event name.
fnfunctionNoThe listener function.
context*Yes"this"The context to invoke the listener with.

Returns: Phaser.Tweens.Tween - this.

Inherits: Phaser.Events.EventEmitter#once

Source: src/events/EventEmitter.js - Line: 124
Since: 3.0.0


onCompleteHandler

<instance> onCompleteHandler()

Description:

Internal method that handles this tween completing and starting the next tween in the chain, if any.

Overrides: Phaser.Tweens.BaseTween#onCompleteHandler

Source: src/tweens/tween/Tween.js - Line: 404
Since: 3.60.0


pause

<instance> pause()

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: Phaser.Tweens.Tween - This Tween instance.

Fires: Phaser.Tweens.Events#event:TWEEN_PAUSE

Inherits: Phaser.Tweens.BaseTween#pause

Source: src/tweens/tween/BaseTween.js - Line: 329
Since: 3.60.0


play

<instance> play()

Description:

Starts a Tween playing.

You only need to call this method if you have configured the tween to be paused on creation.

If the Tween is already playing, calling this method again will have no effect. If you wish to restart the Tween, use Tween.restart instead.

Calling this method after the Tween has completed will start the Tween playing again from the beginning. This is the same as calling Tween.seek(0) and then Tween.play().

Returns: Phaser.Tweens.Tween - This Tween instance.

Source: src/tweens/tween/Tween.js - Line: 419
Since: 3.0.0


remove

<instance> remove()

Description:

Immediately removes this Tween from the TweenManager and all of its internal arrays, no matter what stage it is at. Then sets the tween state to REMOVED.

You should dispose of your reference to this tween after calling this method, to free it from memory. If you no longer require it, call Tween.destroy() on it.

Returns: Phaser.Tweens.Tween - This Tween instance.

Inherits: Phaser.Tweens.BaseTween#remove

Source: src/tweens/tween/BaseTween.js - Line: 466
Since: 3.60.0


removeAllListeners

<instance> removeAllListeners([event])

Description:

Remove all listeners, or those of the specified event.

Parameters:

nametypeoptionaldescription
eventstring | symbolYesThe event name.

Returns: Phaser.Tweens.Tween - this.

Inherits: Phaser.Events.EventEmitter#removeAllListeners

Source: src/events/EventEmitter.js - Line: 165
Since: 3.0.0


removeListener

<instance> removeListener(event, [fn], [context], [once])

Description:

Remove the listeners of a given event.

Parameters:

nametypeoptionaldescription
eventstring | symbolNoThe event name.
fnfunctionYesOnly remove the listeners that match this function.
context*YesOnly remove the listeners that have this context.
oncebooleanYesOnly remove one-time listeners.

Returns: Phaser.Tweens.Tween - this.

Inherits: Phaser.Events.EventEmitter#removeListener

Source: src/events/EventEmitter.js - Line: 137
Since: 3.0.0


reset

<instance> reset([skipInit])

Description:

Resets this Tween ready for another play-through.

This is called automatically from the Tween Manager, or from the parent TweenChain, and should not typically be invoked directly.

If you wish to restart this Tween, use the Tween.restart or Tween.seek methods instead.

Parameters:

nametypeoptionaldefaultdescription
skipInitbooleanYesfalseSkip resetting the TweenData and Active State?

Returns: Phaser.Tweens.Tween - This Tween instance.

Fires: Phaser.Tweens.Events#event:TWEEN_ACTIVE

Source: src/tweens/tween/Tween.js - Line: 586
Since: 3.60.0


restart

<instance> restart()

Description:

Restarts the Tween from the beginning.

If the Tween has already finished and been destroyed, restarting it will throw an error.

If you wish to restart the Tween from a specific point, use the Tween.seek method instead.

Returns: Phaser.Tweens.Tween - This Tween instance.

Source: src/tweens/tween/Tween.js - Line: 313
Since: 3.0.0


resume

<instance> resume()

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: Phaser.Tweens.Tween - This Tween instance.

Fires: Phaser.Tweens.Events#event:TWEEN_RESUME

Inherits: Phaser.Tweens.BaseTween#resume

Source: src/tweens/tween/BaseTween.js - Line: 352
Since: 3.60.0


rewind

<instance> rewind(ms)

Description:

Moves this Tween backward by the given amount of milliseconds.

It will only rewind through the current loop of the Tween. For example, if the Tween is set to repeat or yoyo, it can only fast forward through a single section of the sequence. Use Tween.seek for more complex playhead control.

If the Tween is paused or has already finished, calling this will have no effect.

Parameters:

nametypeoptionaldescription
msnumberNoThe number of milliseconds to rewind this Tween by.

Returns: Phaser.Tweens.Tween - This Tween instance.

Source: src/tweens/tween/Tween.js - Line: 747
Since: 3.60.0


seek

<instance> seek([amount], [delta], [emit])

Description:

Seeks to a specific point in the Tween.

The given amount is a value in milliseconds that represents how far into the Tween you wish to seek, based on the start of the Tween.

Note that the seek amount takes the entire duration of the Tween into account, including delays, loops and repeats. For example, a Tween that lasts for 2 seconds, but that loops 3 times, would have a total duration of 6 seconds, so seeking to 3000 ms would seek to the Tweens half-way point based on its entire duration.

Prior to Phaser 3.60 this value was given as a number between 0 and 1 and didn't work for Tweens had an infinite repeat. This new method works for all Tweens.

Seeking works by resetting the Tween to its initial values and then iterating through the Tween at delta jumps per step. The longer the Tween, the longer this can take. If you need more precision you can reduce the delta value. If you need a faster seek, you can increase it. When the Tween is reset it will refresh the starting and ending values. If these are coming from a dynamic function, or a random array, it will be called for each seek.

While seeking the Tween will not emit any of its events or callbacks unless the 3rd parameter is set to true.

If this Tween is paused, seeking will not change this fact. It will advance the Tween to the desired point and then pause it again.

Parameters:

nametypeoptionaldefaultdescription
amountnumberYes0The number of milliseconds to seek into the Tween from the beginning.
deltanumberYes16.6The size of each step when seeking through the Tween. A higher value completes faster but at the cost of less precision.
emitbooleanYesfalseWhile seeking, should the Tween emit any of its events or callbacks? The default is 'false', i.e. to seek silently.

Returns: Phaser.Tweens.Tween - This Tween instance.

Source: src/tweens/tween/Tween.js - Line: 456
Since: 3.0.0


setActiveState

<instance> setActiveState()

Description:

Sets this Tween state to ACTIVE.

Inherits: Phaser.Tweens.BaseTween#setActiveState

Source: src/tweens/tween/BaseTween.js - Line: 640
Since: 3.60.0


setCallback

<instance> setCallback(type, callback, [params])

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:

nametypeoptionaldescription
typePhaser.Types.Tweens.TweenCallbackTypesNoThe type of callback to set. One of: onActive, onComplete, onLoop, onPause, onRepeat, onResume, onStart, onStop, onUpdate or onYoyo.
callbackfunctionNoYour callback that will be invoked.
paramsarrayYesThe 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: Phaser.Tweens.Tween - This Tween instance.

Inherits: Phaser.Tweens.BaseTween#setCallback

Source: src/tweens/tween/BaseTween.js - Line: 587
Since: 3.60.0


setCompleteDelayState

<instance> setCompleteDelayState()

Description:

Sets this Tween state to COMPLETE_DELAY.

Inherits: Phaser.Tweens.BaseTween#setCompleteDelayState

Source: src/tweens/tween/BaseTween.js - Line: 664
Since: 3.60.0


setDestroyedState

<instance> setDestroyedState()

Description:

Sets this Tween state to DESTROYED.

Inherits: Phaser.Tweens.BaseTween#setDestroyedState

Source: src/tweens/tween/BaseTween.js - Line: 723
Since: 3.60.0


setFinishedState

<instance> setFinishedState()

Description:

Sets this Tween state to FINISHED.

Inherits: Phaser.Tweens.BaseTween#setFinishedState

Source: src/tweens/tween/BaseTween.js - Line: 712
Since: 3.60.0


setLoopDelayState

<instance> setLoopDelayState()

Description:

Sets this Tween state to LOOP_DELAY.

Inherits: Phaser.Tweens.BaseTween#setLoopDelayState

Source: src/tweens/tween/BaseTween.js - Line: 653
Since: 3.60.0


setPendingRemoveState

<instance> setPendingRemoveState()

Description:

Sets this Tween state to PENDING_REMOVE.

Inherits: Phaser.Tweens.BaseTween#setPendingRemoveState

Source: src/tweens/tween/BaseTween.js - Line: 690
Since: 3.60.0


setPendingState

<instance> setPendingState()

Description:

Sets this Tween state to PENDING.

Inherits: Phaser.Tweens.BaseTween#setPendingState

Source: src/tweens/tween/BaseTween.js - Line: 629
Since: 3.60.0


setRemovedState

<instance> setRemovedState()

Description:

Sets this Tween state to REMOVED.

Inherits: Phaser.Tweens.BaseTween#setRemovedState

Source: src/tweens/tween/BaseTween.js - Line: 701
Since: 3.60.0


setStartDelayState

<instance> setStartDelayState()

Description:

Sets this Tween state to START_DELAY.

Inherits: Phaser.Tweens.BaseTween#setStartDelayState

Source: src/tweens/tween/BaseTween.js - Line: 675
Since: 3.60.0


setTimeScale

<instance> setTimeScale(value)

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:

nametypeoptionaldescription
valuenumberNoThe time scale value to set.

Returns: Phaser.Tweens.Tween - This Tween instance.

Inherits: Phaser.Tweens.BaseTween#setTimeScale

Source: src/tweens/tween/BaseTween.js - Line: 263
Since: 3.60.0


shutdown

<instance> shutdown()

Description:

Removes all listeners.

Inherits: Phaser.Events.EventEmitter#shutdown

Source: src/events/EventEmitter.js - Line: 31
Since: 3.0.0


stop

<instance> stop()

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: Phaser.Tweens.Tween - This Tween instance.

Fires: Phaser.Tweens.Events#event:TWEEN_STOP

Inherits: Phaser.Tweens.BaseTween#stop

Source: src/tweens/tween/BaseTween.js - Line: 488
Since: 3.60.0


update

<instance> update(delta)

Description:

Internal method that advances the Tween based on the time values.

Parameters:

nametypeoptionaldescription
deltanumberNoThe delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.

Returns: boolean - Returns true if this Tween has finished and should be removed from the Tween Manager, otherwise returns false.

Fires: Phaser.Tweens.Events#event:TWEEN_COMPLETE, Phaser.Tweens.Events#event:TWEEN_LOOP, Phaser.Tweens.Events#event:TWEEN_START

Source: src/tweens/tween/Tween.js - Line: 630
Since: 3.0.0


updateCompleteDelay

<instance> updateCompleteDelay(delta)

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:

nametypeoptionaldescription
deltanumberNoThe delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.

Inherits: Phaser.Tweens.BaseTween#updateCompleteDelay

Source: src/tweens/tween/BaseTween.js - Line: 568
Since: 3.60.0


updateLoopCountdown

<instance> updateLoopCountdown(delta)

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:

nametypeoptionaldescription
deltanumberNoThe delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.

Inherits: Phaser.Tweens.BaseTween#updateLoopCountdown

Source: src/tweens/tween/BaseTween.js - Line: 519
Since: 3.60.0


updateStartCountdown

<instance> updateStartCountdown(delta)

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:

nametypeoptionaldescription
deltanumberNoThe delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.

Inherits: Phaser.Tweens.BaseTween#updateStartCountdown

Source: src/tweens/tween/BaseTween.js - Line: 540
Since: 3.60.0


updateTo

<instance> updateTo(key, value, [startToCurrent])

Description:

Updates the 'end' value of the given property across all matching targets, as long as this Tween is currently playing (either forwards or backwards).

Calling this does not adjust the duration of the Tween, or the current progress.

You can optionally tell it to set the 'start' value to be the current value.

If this Tween is in any other state other than playing then calling this method has no effect.

Additionally, if the Tween repeats, is reset, or is seeked, it will revert to the original starting and ending values.

Parameters:

nametypeoptionaldefaultdescription
keystringNoThe property to set the new value for. You cannot update the 'texture' property via this method.
valuenumberNoThe new value of the property.
startToCurrentbooleanYesfalseShould this change set the start value to be the current value?

Returns: Phaser.Tweens.Tween - This Tween instance.

Source: src/tweens/tween/Tween.js - Line: 266
Since: 3.0.0


Updated on