Editor Scripting API
    Preparing search index...

    Class BaseDescriptor

    Base class for plugin descriptors containing metadata and interface requirements.

        // BaseDescriptor fields: id, name, description, dependencies, interfaces
        const desc = new Descriptor();
        desc.id = 'com.example.my-plugin';
        desc.name = 'My Plugin';
        desc.description = 'A sample plugin demonstrating BaseDescriptor fields';
        desc.dependencies = [Editor.Model.IModel];
        desc.interfaces = [];

        console.log(`Descriptor "${desc.name}" (${desc.id}): ${desc.dependencies.length} dependency(ies), ${desc.interfaces.length} interface(s)`);

    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