Editor Scripting API
    Preparing search index...

    Class Descriptor

    Descriptor class for a Preset plugin, providing metadata and configuration used by the plugin system at registration time.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    dependencies description entityType icon id interfaces name pathsToImport section

    Methods

    getTypeName isOfType isSame

    Constructors

    Properties

    dependencies: InterfaceId[]
    description: string

    Human-readable description of the plugin.

    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 string for the plugin.

    interfaces: InterfaceId[]

    List of interface IDs that this plugin implements or exposes.

    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