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

    Type Alias SettingsObject

    type SettingsObject = {
        active: boolean;
        cameras: CameraConfig | CameraConfig[] | null;
        data: object;
        isBooted: boolean;
        isTransition: boolean;
        key: string;
        loader: LoaderConfig;
        map: { [key: string]: string };
        pack: false | PackFileSection;
        physics: PhysicsConfig;
        plugins: false | any;
        status: number;
        transitionAllowInput: boolean;
        transitionDuration: number;
        transitionFrom: Scene | null;
        visible: boolean;
    }
    Index

    Properties

    active: boolean

    The active state of this Scene. An active Scene updates each step.

    cameras: CameraConfig | CameraConfig[] | null

    The Camera configuration object.

    data: object

    a data bundle passed to this Scene from the Scene Manager.

    isBooted: boolean

    Has the Scene finished booting?

    isTransition: boolean

    Is the Scene in a state of transition?

    key: string

    The unique key of this Scene. Unique within the entire Game instance.

    loader: LoaderConfig

    The loader configuration object for the Scene.

    map: { [key: string]: string }

    The Scene's Injection Map.

    pack: false | PackFileSection

    Files to be loaded before the Scene begins.

    physics: PhysicsConfig

    The physics configuration object for the Scene.

    plugins: false | any

    The plugin configuration object for the Scene.

    status: number

    The current status of the Scene. Maps to the Scene constants.

    transitionAllowInput: boolean

    Is this Scene allowed to receive input during transitions?

    transitionDuration: number

    The duration of the transition, if set.

    transitionFrom: Scene | null

    The Scene this Scene is transitioning from, if set.

    visible: boolean

    The visible state of this Scene. A visible Scene renders each step.