mooball
    Preparing search index...

    Interface APICallbacks

    interface APICallbacks {
        onConfigUpdate?(
            oldRoomConfigObj: RoomConfig,
            newRoomConfigObj: RoomConfig,
            customData?: any,
        ): any;
        onLanguageChange?(abbr: string, customData?: any): any;
        onLibraryAdd?(libraryObj: Library, customData?: any): any;
        onLibraryMove?(libraryObj: Library, customData?: any): any;
        onLibraryRemove?(libraryObj: Library, customData?: any): any;
        onLibraryUpdate?(
            oldLibraryObj: Library,
            newLibraryObj: Library,
            customData?: any,
        ): any;
        onPluginActiveChange?(plugin: Plugin, customData?: any): any;
        onPluginAdd?(pluginObj: Plugin, customData?: any): any;
        onPluginMove?(pluginObj: Plugin, customData?: any): any;
        onPluginRemove?(pluginObj: Plugin, customData?: any): any;
        onPluginUpdate?(
            oldPluginObj: Plugin,
            newPluginObj: Plugin,
            customData?: any,
        ): any;
        onRendererUpdate?(
            oldRendererObj: Renderer,
            newRendererObj: Renderer,
            customData?: any,
        ): any;
        onVariableValueChange?(
            addonObject: Addon,
            variableName: string,
            oldValue: any,
            newValue: any,
            customData?: any,
        ): any;
    }
    Index

    Methods

    onConfigUpdate? onLanguageChange? onLibraryAdd? onLibraryMove? onLibraryRemove? onLibraryUpdate? onPluginActiveChange? onPluginAdd? onPluginMove? onPluginRemove? onPluginUpdate? onRendererUpdate? onVariableValueChange?

    Methods

    • Called just after the room's config object has been replaced by a new one.

      Parameters

      • oldRoomConfigObj: RoomConfig

        The old RoomConfig object.

      • newRoomConfigObj: RoomConfig

        The new RoomConfig object.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

      void or a custom data to pass to the next callback.

    • Called just after the API's language has been changed.

      Parameters

      • abbr: string

        The new language's abbreviation value.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

      void or a custom data to pass to the next callback.

    • Called just after a library object has been added.

      Parameters

      • libraryObj: Library

        The Library object.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

      void or a custom data to pass to the next callback.

    • Called just after a library object has been moved.

      Parameters

      • libraryObj: Library

        The Library object.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

      void or a custom data to pass to the next callback.

    • Called just after a library object has been removed.

      Parameters

      • libraryObj: Library

        The Library object.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

      void or a custom data to pass to the next callback.

    • Called just after an old library object has been replaced by a new one.

      Parameters

      • oldLibraryObj: Library

        The old Library object.

      • newLibraryObj: Library

        The new Library object.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

      void or a custom data to pass to the next callback.

    • Called just after a plugin has been activated or deactivated.

      Parameters

      • plugin: Plugin

        The plugin which was activated or deactivated. This property stores the current activation status of the plugin: plugin.active.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

      void or a custom data to pass to the next callback.

    • Called just after a plugin object has been added.

      Parameters

      • pluginObj: Plugin

        The Plugin object.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

      void or a custom data to pass to the next callback.

    • Called just after a plugin object has been moved.

      Parameters

      • pluginObj: Plugin

        The Plugin object.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

      void or a custom data to pass to the next callback.

    • Called just after a plugin object has been removed.

      Parameters

      • pluginObj: Plugin

        The Plugin object.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

      void or a custom data to pass to the next callback.

    • Called just after an old plugin object has been replaced by a new one.

      Parameters

      • oldPluginObj: Plugin

        The old Plugin object.

      • newPluginObj: Plugin

        The new Plugin object.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

      void or a custom data to pass to the next callback.

    • Called just after the room's renderer object has been replaced by a new one.

      Parameters

      • oldRendererObj: Renderer

        The old Renderer object.

      • newRendererObj: Renderer

        The new Renderer object.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

      void or a custom data to pass to the next callback.

    • Called just after the value of a variable has been changed.

      Parameters

      • addonObject: Addon

        The Addon object that the variable belongs to.

      • variableName: string

        The name of the variable whose value has been changeed.

      • oldValue: any

        The old value of the variable.

      • newValue: any

        The new value of the variable.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

      void or a custom data to pass to the next callback.

    Settings

    Member Visibility

    On This Page

    Methods