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

    Type Alias TweenDataConfig

    type TweenDataConfig = {
        current?: number;
        delay?: number;
        duration?: number;
        ease: Function;
        elapsed?: number;
        end?: number;
        flipX?: boolean;
        flipY?: boolean;
        gen?: TweenDataGenConfig;
        getActiveValue: GetActiveCallback | null;
        getEndValue: GetEndCallback;
        getStartValue: GetStartCallback;
        hold?: number;
        index: number;
        key: string;
        previous?: number;
        progress?: number;
        repeat?: number;
        repeatCounter?: number;
        repeatDelay?: number;
        start?: number;
        state?: StateType;
        target: any;
        totalDuration?: number;
        yoyo?: boolean;
    }
    Index

    Properties

    current? delay? duration? ease elapsed? end? flipX? flipY? gen? getActiveValue getEndValue getStartValue hold? index key previous? progress? repeat? repeatCounter? repeatDelay? start? state? target totalDuration? yoyo?

    Properties

    current?: number

    The current propety value.

    delay?: number

    Time in milliseconds before tween will start.

    duration?: number

    Duration of the tween in milliseconds, excludes time for yoyo or repeats.

    ease: Function

    The ease function this tween uses.

    elapsed?: number

    Delta counter

    end?: number

    The property value at the end of the ease.

    flipX?: boolean

    Automatically call toggleFlipX when the TweenData yoyos or repeats

    flipY?: boolean

    Automatically call toggleFlipY when the TweenData yoyos or repeats

    gen?: TweenDataGenConfig

    LoadValue generation functions.

    getActiveValue: GetActiveCallback | null

    If not null, is invoked immediately as soon as the TweenData is running, and is set on the target property.

    getEndValue: GetEndCallback

    The returned value sets what the property will be at the END of the Tween.

    getStartValue: GetStartCallback

    The returned value sets what the property will be at the START of the Tween.

    hold?: number

    Time in milliseconds the tween will pause before running the yoyo or starting a repeat.

    index: number

    The target index within the Tween targets array.

    key: string

    The property of the target being tweened.

    previous?: number

    The previous property value.

    progress?: number

    Between 0 and 1 showing completion of this TweenData.

    repeat?: number

    Number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice.

    repeatCounter?: number

    How many repeats are left to run?

    repeatDelay?: number

    Time in milliseconds before the repeat will start.

    start?: number

    The property value at the start of the ease.

    state?: StateType

    TWEEN_CONST.CREATED

    target: any

    The target to tween.

    totalDuration?: number

    The total calculated duration of this TweenData (based on duration, repeat, delay and yoyo)

    yoyo?: boolean

    Cause the tween to return back to its start value after hold has expired.

    Settings

    Member Visibility

    On This Page

    Properties