IdaJS
    Preparing search index...

    Interface SceneEvents

    Scene events the mod can subscribe to to perform necessary setup actions.

    scene.Events.

    interface SceneEvents {
        afterLoadSavedState: "afterLoadSavedState";
        afterLoadScene: "afterLoadScene";
        beforeLoadScene: "beforeLoadScene";
    }
    Index

    Properties

    afterLoadSavedState afterLoadScene beforeLoadScene

    Properties

    afterLoadSavedState: "afterLoadSavedState"

    Fired after a saved game is loaded from a save file to this scene. Happens after SceneEvents.afterLoadScene

    The mod should not need to subscribe to this event, but it's used by the system.

    This event is for internal usage. Only use it if you know what you are doing.

    AfterLoadSavedStateCallback

    afterLoadScene: "afterLoadScene"

    Fired right after a scene is loaded by any reason.

    This is the main entry point for the mod to setup everything in the scene.

    Use to setup scene objects, zones and waypoints, custom life handlers, register coroutines, and do other initial setup.

    AfterLoadSceneCallback

    beforeLoadScene: "beforeLoadScene"

    Fired right before a scene is loaded by any reason.

    This is not needed often in the mods. Can be used to initialize storm state, palette, and verify the compatibility of saved games.

    The example of this event handler usage can be seen in the storm sample.

    BeforeLoadSceneCallback

    Settings

    Member Visibility

    On This Page

    Properties