Editor Scripting API
    Preparing search index...

    Class InspectableMeta

    Metadata for an inspectable object, providing display caption and icon for use in the Editor UI.

        // InspectableMeta exposes a human-readable caption and an icon for any
        // inspectable entity. Look it up via IEntityRegistry.getMeta(typeName).
        const registry = this.pluginSystem.findInterface(
          Editor.Model.IEntityRegistry
        ) as Editor.Model.IEntityRegistry;

        const meta = registry.getMeta('SceneObject') as Editor.Model.InspectableMeta;
        console.log(`SceneObject caption: ${meta.caption}`);
        console.log(`Has icon: ${!Editor.isNull(meta.icon)}`);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    caption icon isAbstract

    Methods

    getTypeName isOfType isSame

    Constructors

    Properties

    caption: string

    Read-only string label displayed for this inspectable in the Editor.

    icon: Editor.Icon

    Read-only icon associated with this inspectable in the Editor UI.

    isAbstract: boolean

    Whether the entity can be created.

    Methods

    • Returns the name of this object's type.

      Returns string

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object refers to the same instance as the given object.

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods