Editor Scripting API
    Preparing search index...

    Class Descriptor

    Descriptor subclass for presets, extending BaseDescriptor with preset-specific metadata such as import paths and section.

        // Preset.Descriptor extends BaseDescriptor and adds properties that
        // configure how the preset appears in the Add menu.
        const d = new Descriptor();
        d.id = 'com.docs.PresetDescriptorExample';
        d.name = 'Camera Rig';
        d.entityType = 'SceneObject';
        d.section = 'Camera';
        d.pathsToImport = [new Editor.Path('assets/camera_rig.lso')];
        // d.icon = Editor.Icon.fromFile(...);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    dependencies description entityType icon id interfaces name pathsToImport section

    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.

    entityType: string

    Specifies the target entity type the preset operates on: 'SceneObject', 'Asset', or 'Component'.

    icon: Editor.Icon

    Icon displayed for the preset in the Lens Studio UI, created via Editor.Icon.fromFile().

    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.

    pathsToImport: Path[]

    List of asset paths to import when the preset is instantiated.

    section: string

    Category or group name under which the preset appears in the preset picker UI.

    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