phaser - v4.0.0-rc.4
    Preparing search index...

    Type Alias TweenChainBuilderConfig

    TweenChainBuilderConfig: { [key: string]: any } & {
        callbackScope?: any;
        completeDelay?: string | number | Function | object | any[];
        delay?: number | Function;
        loop?: string | number | Function | object | any[];
        loopDelay?: string | number | Function | object | any[];
        onActive?: TweenOnActiveCallback;
        onActiveParams?: any[];
        onComplete?: TweenOnCompleteCallback;
        onCompleteParams?: any[];
        onLoop?: TweenOnLoopCallback;
        onLoopParams?: any[];
        onPause?: TweenOnPauseCallback;
        onPauseParams?: any[];
        onResume?: TweenOnResumeCallback;
        onResumeParams?: any[];
        onStart?: TweenOnStartCallback;
        onStartParams?: any[];
        onStop?: TweenOnStopCallback;
        onStopParams?: any[];
        paused?: boolean;
        persist?: boolean;
        targets: any;
        tweens?: TweenBuilderConfig[];
    }

    Type declaration

    • [key: string]: any
    • OptionalcallbackScope?: any

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

    • OptionalcompleteDelay?: string | number | Function | object | any[]

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

    • Optionaldelay?: number | Function

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

    • Optionalloop?: string | number | Function | object | any[]

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

    • OptionalloopDelay?: string | number | Function | object | any[]

      The time the chain will pause before returning to the start for a repeat.

    • OptionalonActive?: TweenOnActiveCallback

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

    • OptionalonActiveParams?: any[]

      Additional parameters to pass to onActive.

    • OptionalonComplete?: TweenOnCompleteCallback

      A function to call when the chain completes.

    • OptionalonCompleteParams?: any[]

      Additional parameters to pass to onComplete.

    • OptionalonLoop?: TweenOnLoopCallback

      A function to call each time the chain loops.

    • OptionalonLoopParams?: any[]

      Additional parameters to pass to onLoop.

    • OptionalonPause?: TweenOnPauseCallback

      A function to call when the chain is paused.

    • OptionalonPauseParams?: any[]

      Additional parameters to pass to onPause.

    • OptionalonResume?: TweenOnResumeCallback

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

    • OptionalonResumeParams?: any[]

      Additional parameters to pass to onResume.

    • OptionalonStart?: TweenOnStartCallback

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

    • OptionalonStartParams?: any[]

      Additional parameters to pass to onStart.

    • OptionalonStop?: TweenOnStopCallback

      A function to call when the chain is stopped.

    • OptionalonStopParams?: any[]

      Additional parameters to pass to onStop.

    • Optionalpaused?: boolean

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

    • Optionalpersist?: boolean

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

    • targets: any

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

    • Optionaltweens?: TweenBuilderConfig[]

      The tweens to chain together.

    Settings

    Member Visibility