Interface Tween

A tween that is being configured.

interface Tween {
    events: Events;
    add<T extends object>(
        target: T,
        endValues: Partial<NumericValues<T>>,
        easing?: EasingFunction,
    ): Tween;
    chain(behavior?: Settings): Tween;
    start(timeFrame?: default): ActiveTween;
}

Hierarchy (View Summary)

Index

Properties

Methods

add chain start

Properties

`Readonly`events

events: Events

For listening to life-cycle events.

Methods

add

add<T extends object>(
    target: T,
    endValues: Partial<NumericValues<T>>,
    easing?: EasingFunction,
): Tween
Adds an object to the behavior.
Type Parameters
- T extends object
Parameters
- target: T
- endValues: Partial<NumericValues<T>>
- Optionaleasing: EasingFunction
Returns Tween
Throws
InvalidOperationException if the tween has already been started.
Inherited from Tweenable.add
- Defined in Tweening.d.ts:74

chain

chain(behavior?: Settings): Tween
Allows for tweens to occur in sequence.
Parameters
- Optionalbehavior: Settings
Returns Tween
Throws
InvalidOperationException if the tween has already been started.
- Defined in Tweening.d.ts:205

start

start(timeFrame?: default): ActiveTween
Starts the tween.
Parameters
- OptionaltimeFrame: default
Returns ActiveTween
- Defined in Tweening.d.ts:197