Editor Scripting API
    Preparing search index...

    Class Descriptor

    Descriptor used to configure and register an overlay plugin.

        // OverlayPlugin.Descriptor extends BaseDescriptor with no extra properties.
        // Use it to register an overlay plugin that renders UI on top of the viewport.
        const d = new Descriptor();
        d.id = 'com.docs.OverlayPluginDescriptorExample';
        d.name = 'Overlay Descriptor Example';
        d.description = 'A floating overlay panel';
        d.dependencies = [];

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    dependencies description id interfaces name

    Methods

    getTypeName isOfType isSame

    Constructors

    Properties

    dependencies: InterfaceId[]

    Array of interface IDs that this plugin requires to function.

    description: string

    Human-readable description of the plugin shown in the plugin manager.

    id: string

    Unique identifier for the plugin, typically in reverse domain notation.

    interfaces: InterfaceId[]

    Array of interface IDs that this plugin provides or implements.

    name: string

    Display name of the plugin.

    Methods

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

      Parameters

      • type: string

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods