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

    Type Alias NumberTweenBuilderConfig

    type NumberTweenBuilderConfig = {
        callbackScope?: any;
        completeDelay?: string | number | Function | object | any[];
        delay?: number;
        duration?: number;
        ease?: string | Function;
        easeParams?: any[];
        from?: number;
        hold?: number;
        interpolation?: string | Function;
        loop?: string | number | Function | object | any[];
        loopDelay?: string | number | Function | object | any[];
        onComplete?: TweenOnCompleteCallback;
        onCompleteParams?: 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;
        repeat?: number;
        repeatDelay?: number;
        to?: number;
        yoyo?: boolean;
    }
    Index

    Properties

    callbackScope?: any

    Scope (this) for the callbacks. The default scope is the counter.

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

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

    delay?: number

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

    duration?: number

    The duration of the counter in milliseconds.

    ease?: string | Function

    The easing equation to use for the counter.

    easeParams?: any[]

    Optional easing parameters.

    from?: number

    The start number.

    hold?: number

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

    interpolation?: string | Function

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

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

    The number of times the counter will repeat. (A value of 1 means the counter will play twice, as it repeated once.)

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

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

    A function to call when the counter completes.

    onCompleteParams?: any[]

    Additional parameters to pass to onComplete.

    A function to call each time the counter loops.

    onLoopParams?: any[]

    Additional parameters to pass to onLoop.

    A function to call when the counter is paused.

    onPauseParams?: any[]

    Additional parameters to pass to onPause.

    A function to call each time the counter repeats.

    onRepeatParams?: any[]

    Additional parameters to pass to onRepeat.

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

    onResumeParams?: any[]

    Additional parameters to pass to onResume.

    A function to call when the counter starts.

    onStartParams?: any[]

    Additional parameters to pass to onStart.

    A function to call when the counter is stopped.

    onStopParams?: any[]

    Additional parameters to pass to onStop.

    A function to call each time the counter steps.

    onUpdateParams?: any[]

    Additional parameters to pass to onUpdate.

    A function to call each time the counter yoyos.

    onYoyoParams?: any[]

    Additional parameters to pass to onYoyo.

    paused?: boolean

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

    persist?: boolean

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

    repeat?: number

    The number of times to repeat the counter.

    repeatDelay?: number

    The number of milliseconds to pause before the counter will repeat.

    to?: number

    The end number.

    yoyo?: boolean

    Should the counter play forward to the end value and then backwards to the start? The reverse playback will also take duration milliseconds to complete.