Skip to main content

LensStudio:EntityGenerator.Descriptor

Class

Configuration descriptor for an entity generator, specifying entity type and icon.

Index

Example

// EntityGenerator.Descriptor extends BaseDescriptor and adds properties
// for configuring how the generator appears in the editor UI.
const d = new Descriptor();
d.id = 'com.docs.EntityGeneratorDescriptorExample';
d.name = 'Custom Asset Generator';
d.entityType = 'Asset';
d.displayOrder = 50;
// d.icon = new Editor.Icon(...);

Extends

Constructors

Constructor

new Descriptor(): Descriptor

Creates a new Descriptor instance for configuring an entity generator plugin.

Returns

Descriptor

Overrides

BaseDescriptor.constructor

Properties

dependencies

dependencies: InterfaceId[]

Array of interface IDs that this plugin requires to function.

Inherited from

BaseDescriptor.dependencies


description

description: string

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

Inherited from

BaseDescriptor.description


displayOrder

displayOrder: number

Numeric order controlling where this generator appears in the UI relative to others.


entityType

entityType: string

Target entity category this generator creates 'SceneObject', 'Asset', or 'Component'.


icon

icon: Icon

Icon displayed for this generator in the Lens Studio UI.


id

id: string

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

Inherited from

BaseDescriptor.id


intendedPlatforms

intendedPlatforms: TargetPlatform[]

Array of target platforms (Snapchat, Spectacles) where this plugin is intended to run.

Inherited from

BaseDescriptor.intendedPlatforms


interfaces

interfaces: InterfaceId[]

Array of interface IDs that this plugin provides or implements.

Inherited from

BaseDescriptor.interfaces


name

name: string

Display name of the plugin.

Inherited from

BaseDescriptor.name

Methods

getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

BaseDescriptor.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

BaseDescriptor.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

BaseDescriptor.isOfType


isSame()

isSame(other): boolean

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

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

BaseDescriptor.isSame