Class RunningTween<T>

This class represents a running tween for a specific target object. It manages the execution of actions and tweens associated with the tween. Don't instantiate this manually.

Type Parameters

  • T = any

    The type of the target object.

Constructors

constructor

Properties

_finished actionIndex currentBlock? history originallyReversed? paused repeat? repetitions reversed? root target timeScale tween tweenManager

Accessors

finished

Methods

complete execute getBlock getTweensDelta pause resume setTimeScale stop

Constructors

constructor

Properties

Internal _finished

_finished: boolean = false

Internal actionIndex

actionIndex: number = -1

Optional Internal currentBlock

currentBlock?: RunningBlock

Internal history

history: RunningBlock[] = []

Optional Internal originallyReversed

originallyReversed?: boolean

paused

paused: boolean = false

Indicates whether the execution of the running tween is paused. If set to true, the tween will not progress until it is resumed.

Optional Internal repeat

repeat?: boolean

Internal repetitions

repetitions: {
    [x: number]: number;
} = {}

Type declaration

  • [x: number]: number

Optional Internal reversed

reversed?: boolean

Internal root

root: RunningTween<T>

Internal target

target: T

timeScale

timeScale: number = 1

The time scale factor for the running tween. It determines the speed at which the tween progresses. A value of 1 represents normal speed, while 0.5 would be half-speed, and 2 would be double-speed.

Internal tween

tween: Tween<T>

tweenManager

tweenManager: TweenManager

Accessors

finished

  • get finished(): boolean

  • Indicates whether the running tween has finished executing.

    Returns boolean

Methods

complete

  • complete(): void

  • Complete the running tween, causing it to finish immediately.

    Returns void

execute

  • execute(delta): boolean
  • Internal

    Parameters

    • delta: number

    Returns boolean

getBlock

  • getBlock(): RunningBlock
  • Internal

    Returns RunningBlock

getTweensDelta

  • getTweensDelta(block): number
  • Internal

    Parameters

    • block: RunningBlock

    Returns number

pause

  • pause(): void

  • Pause the execution of the running tween.

    Returns void

resume

  • resume(): void

  • Resume the execution of the running tween if it was paused.

    Returns void

setTimeScale

  • setTimeScale(value): this

  • Set the time scale for the running tween.

    Parameters

    • value: number

      The time scale value to apply.

    Returns this

    The updated RunningTween instance.

stop

  • stop(): void

  • Stop the running tween, causing it to finish immediately.

    Returns void

Settings

Member Visibility

Theme

On This Page