LensStudio:GuiService.Descriptor
ClassDescriptor object for configuring a GuiService plugin instance.
Index
Example
// GuiService.Descriptor extends BaseDescriptor with no extra properties.
// Use it when defining a GuiService-based plugin.
const d = new Descriptor();
d.id = 'com.docs.GuiServiceDescriptorExample';
d.name = 'GuiService Descriptor Example';
d.dependencies = [];
Extends
Constructors
Constructor
new Descriptor():
Descriptor
Constructs a new GuiService Descriptor instance.
Returns
Descriptor
Overrides
BaseDescriptor.constructor
Properties
dependencies
dependencies:
InterfaceId[]
Array of interface IDs that this plugin requires to function.
Inherited from
description
description:
string
Human-readable description of the plugin shown in the plugin manager.
Inherited from
id
id:
string
Unique identifier for the plugin, typically in reverse domain notation.
Inherited from
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
name
name:
string
Display name of the plugin.
Inherited from
Methods
getTypeName()
staticgetTypeName():string
Returns the type name of this class.
Returns
string
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object is of the specified type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object refers to the same instance as the given object.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean