Class GuiService

Plugin that manages and serves GUI components within the Lens Studio editor.

Hierarchy (View Summary)

IPlugin
- GuiService

Index

Constructors

Properties

id pluginSystem

Methods

getTypeName isOfType isSame start stop

Constructors

constructor

new GuiService(pluginSystem: PluginSystem, descriptor?: Descriptor): GuiService
Constructs a GuiService plugin instance with the given plugin system and optional descriptor.
Parameters
- pluginSystem: PluginSystem
- Optionaldescriptor: Descriptor
Returns GuiService
Overrides IPlugin.constructor

Properties

`Readonly`id

id: string

`Readonly`pluginSystem

pluginSystem: PluginSystem

The plugin system instance this service is registered with.

Methods

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

start

start(): void
Starts the GUI service and initializes its GUI components.

Returns void

stop

stop(): void
Stops the GUI service and tears down its GUI components.

Returns void