PokéRogue
    Preparing search index...

    Interface PlayTweenConfig

    interface PlayTweenConfig {
        callbackScope?: any;
        completeDelay?: string | number | object | Function | any[];
        delay?: number | Function;
        duration?: number;
        ease?: string | Function;
        easeParams?: any[];
        flipX?: boolean;
        flipY?: boolean;
        hold?: number;
        interpolation?: string | Function;
        loop?: string | number | object | Function | any[];
        loopDelay?: string | number | object | Function | any[];
        onActive?: TweenOnActiveCallback;
        onActiveParams?: any[];
        onLoop?: TweenOnLoopCallback;
        onLoopParams?: any[];
        onPause?: TweenOnPauseCallback;
        onPauseParams?: any[];
        onRepeat?: TweenOnRepeatCallback;
        onRepeatParams?: any[];
        onResume?: TweenOnResumeCallback;
        onResumeParams?: any[];
        onStart?: TweenOnStartCallback;
        onStartParams?: any[];
        onStop?: TweenOnStopCallback;
        onStopParams?: any[];
        onUpdate?: TweenOnUpdateCallback;
        onUpdateParams?: any[];
        onYoyo?: TweenOnYoyoCallback;
        onYoyoParams?: any[];
        paused?: boolean;
        persist?: boolean;
        props?: {
            [key: string]: string | number | GetEndCallback | TweenPropConfig;
        };
        repeat?: number;
        repeatDelay?: number;
        targets: any;
        yoyo?: boolean;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Properties

    callbackScope?: any

    The scope (or context) for all of the callbacks. The default scope is the tween.

    completeDelay?: string | number | object | Function | any[]

    The time the tween will wait before the onComplete event is dispatched once it has completed, in ms.

    delay?: number | Function

    The number of milliseconds to delay before the tween will start.

    duration?: number

    The duration of the tween in milliseconds.

    ease?: string | Function

    The easing equation to use for the tween.

    easeParams?: any[]

    Optional easing parameters.

    flipX?: boolean

    Horizontally flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the flipX property.

    flipY?: boolean

    Vertically flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the flipY property.

    hold?: number

    The number of milliseconds to hold the tween for before yoyo'ing.

    interpolation?: string | Function

    The interpolation function to use if the value given is an array of numbers.

    loop?: string | number | object | Function | any[]

    The number of times the tween will repeat. (A value of 1 means the tween will play twice, as it repeated once.) The first loop starts after every property in the tween has completed once.

    loopDelay?: string | number | object | Function | any[]

    The time the tween will pause before starting either a yoyo or returning to the start for a repeat.

    A function to call when the tween becomes active within the Tween Manager.

    onActiveParams?: any[]

    Additional parameters to pass to onActive.

    A function to call each time the tween loops.

    onLoopParams?: any[]

    Additional parameters to pass to onLoop.

    A function to call when the tween is paused.

    onPauseParams?: any[]

    Additional parameters to pass to onPause.

    A function to call each time a property tween repeats. Called once per property per target.

    onRepeatParams?: any[]

    Additional parameters to pass to onRepeat.

    A function to call when the tween is resumed after being paused.

    onResumeParams?: any[]

    Additional parameters to pass to onResume.

    A function to call when the tween starts playback, after any delays have expired.

    onStartParams?: any[]

    Additional parameters to pass to onStart.

    A function to call when the tween is stopped.

    onStopParams?: any[]

    Additional parameters to pass to onStop.

    A function to call each time the tween steps. Called once per property per target.

    onUpdateParams?: any[]

    Additional parameters to pass to onUpdate.

    A function to call each time a property tween yoyos. Called once per property per target.

    onYoyoParams?: any[]

    Additional parameters to pass to onYoyo.

    paused?: boolean

    Does the tween start in a paused state (true) or playing (false)?

    persist?: boolean

    Will the Tween be automatically destroyed on completion, or retained for future playback?

    props?: { [key: string]: string | number | GetEndCallback | TweenPropConfig }

    The properties to tween.

    repeat?: number

    The number of times each property tween repeats.

    repeatDelay?: number

    The number of milliseconds to pause before a repeat.

    targets: any

    The object, or an array of objects, to run the tween on.

    yoyo?: boolean

    Should the tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take duration milliseconds to complete.