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

    Type Alias SceneTransitionConfig

    type SceneTransitionConfig = {
        allowInput?: boolean;
        data?: any;
        duration?: number;
        moveAbove?: boolean;
        moveBelow?: boolean;
        onStart?: SceneTransitionOnStartCallback;
        onStartScope?: any;
        onUpdate?: Function;
        onUpdateScope?: any;
        remove?: boolean;
        sleep?: boolean;
        target: string;
    }
    Index

    Properties

    allowInput?: boolean

    Will the Scenes Input system be able to process events while it is transitioning in or out?

    data?: any

    An object containing any data you wish to be passed to the target scene's init / create methods (if sleep is false) or to the target scene's wake event callback (if sleep is true).

    duration?: number

    The duration, in ms, for the transition to last.

    moveAbove?: boolean

    Move the target Scene to be above this one before the transition starts.

    moveBelow?: boolean

    Move the target Scene to be below this one before the transition starts.

    This callback is invoked when transition starting.

    onStartScope?: any

    The context in which the callback is invoked.

    onUpdate?: Function

    This callback is invoked every frame for the duration of the transition.

    onUpdateScope?: any

    The context in which the callback is invoked.

    remove?: boolean

    Will the Scene responsible for the transition be removed from the Scene Manager after the transition completes?

    sleep?: boolean

    Will the Scene responsible for the transition be sent to sleep on completion (true), or stopped? (false)

    target: string

    The Scene key to transition to.