Class EditorPlugin

Base class for Lens Studio editor plugins that can create UI widgets and respond to entity edits.

Hierarchy (View Summary)

IPlugin
- EditorPlugin

Index

Constructors

Properties

id pluginSystem

Methods

createWidget deinit edit getTypeName isOfType isSame

Constructors

constructor

new EditorPlugin(
pluginSystem: PluginSystem,
descriptor?: Descriptor,
): EditorPlugin
Constructs an EditorPlugin instance, optionally bound to a plugin system and descriptor.
Parameters
- pluginSystem: PluginSystem
- Optionaldescriptor: Descriptor
Returns EditorPlugin
Overrides IPlugin.constructor

Properties

`Readonly`id

id: string

`Readonly`pluginSystem

pluginSystem: PluginSystem

The plugin system instance this plugin belongs to.

Methods

createWidget

createWidget(parent: Widget): Widget
Creates and returns a widget parented to the given parent widget.
Parameters
- parent: Widget
Returns Widget

deinit

deinit(): void
Cleans up and deinitializes the plugin.

Returns void

edit

edit(entities: Entity[]): boolean
Handles editing of the given entities, returning true if the plugin handled them.
Parameters
- entities: Entity[]
Returns boolean

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from IPlugin.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from IPlugin.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object refers to the same instance as the given object.
Parameters
- other: ScriptObject
Returns boolean
Inherited from IPlugin.isSame