Script API - v1.21.0
    Preparing search index...

    The simple tool wrapper will create, bind and manage the lifecycle of all the desired components. The wrapper is designed to obfuscate and simplify the process of creating a simple editor tool so that a creator can get on with the job of just creating the tool functionality without getting mired in the irrelevant details of component lifecycle and visibility management. The wrapper will also attempt to codify particular implementation patterns and requirements that are common to all editor tools, and enforce them in a consistent way. It should also go some way to insulating the creator from underlying system and implementation changes as the editor evolves.

    interface ISimpleTool {
        get menu(): IMenu;
        get name(): string;
        get pane(): ISimpleToolPaneComponent;
        get session(): IPlayerUISession;
        get statusBar(): ISimpleToolStatusBarComponent;
        get toolRail(): ISimpleToolRailComponent;
        findPane(idString: string): ISimpleToolPaneComponent;
        hidePane(idString?: string): void;
        logDebug(message: string): void;
        logError(message: string): void;
        logInfo(message: string): void;
        logWarn(message: string): void;
        showPane(idString?: string): void;
        showPaneExclusively(idString: string): void;
        teardown(): void;
    }
    Index

    Accessors

    • get name(): string
      Beta

      Returns string

    Methods

    • Beta

      Parameters

      • OptionalidString: string

      Returns void

    • Beta

      Parameters

      • message: string

      Returns void

    • Beta

      Parameters

      • message: string

      Returns void

    • Beta

      Parameters

      • message: string

      Returns void

    • Beta

      Parameters

      • message: string

      Returns void

    • Beta

      Parameters

      • OptionalidString: string

      Returns void

    • Beta

      Parameters

      • idString: string

      Returns void

    • Beta

      Returns void