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

    Type Alias TimelineEvent

    type TimelineEvent = {
        complete: boolean;
        event?: string;
        if?: Function;
        loop?: Function;
        once: boolean;
        repeat?: Function;
        run?: Function;
        set?: object;
        sound?: string | object;
        target?: any;
        time: number;
        tween?: TweenBuilderConfig | TweenChainBuilderConfig | Tween | TweenChain;
        tweenInstance?: Tween | TweenChain;
    }
    Index

    Properties

    complete: boolean

    Has this event completed yet?

    event?: string

    Optional event name to emit when the Event fires.

    if?: Function

    User-land callback which will be called if set. If it returns true then this event run all of its actions, otherwise it will be skipped.

    loop?: Function

    User-land callback which will be called when the Event loops.

    once: boolean

    Is this a once only event?

    repeat?: Function

    The amount of times this Event has repeated.

    run?: Function

    User-land callback which will be called when the Event fires.

    set?: object

    Object containing properties to set on the target when the Event fires if set.

    sound?: string | object

    Sound configuration object which will be used to create a Sound when the Event fires if set.

    target?: any

    The scope (this object) with which to invoke the run callback.

    time: number

    The time (in elapsed ms) at which this event will fire.

    Tween configuration object which will be used to create a Tween when the Event fires if set.

    tweenInstance?: Tween | TweenChain

    If this Event is using a Tween to manage its actions, this property will contain a reference to it.