BaseDescriptor
ClassBase class for plugin descriptors containing metadata and interface requirements.
Index
Example
// BaseDescriptor fields: id, name, description, dependencies, interfaces
const desc = new Descriptor();
desc.id = 'com.example.my-plugin';
desc.name = 'My Plugin';
desc.description = 'A sample plugin demonstrating BaseDescriptor fields';
desc.dependencies = [Editor.Model.IModel];
desc.interfaces = [];
console.log(`Descriptor "${desc.name}" (${desc.id}): ${desc.dependencies.length} dependency(ies), ${desc.interfaces.length} interface(s)`);
Extends
Extended by
DescriptorDescriptorDescriptorDescriptorDescriptorDescriptorPanelDescriptorDescriptorDescriptorDescriptorDescriptor
Properties
dependencies
dependencies:
InterfaceId[]
Array of interface IDs that this plugin requires to function.
Overrides
IPluginDescriptor.dependencies
description
description:
string
Human-readable description of the plugin shown in the plugin manager.
Overrides
id
id:
string
Unique identifier for the plugin, typically in reverse domain notation.
Overrides
intendedPlatforms
intendedPlatforms:
TargetPlatform[]
Array of target platforms (Snapchat, Spectacles) where this plugin is intended to run.
Overrides
IPluginDescriptor.intendedPlatforms
interfaces
interfaces:
InterfaceId[]
Array of interface IDs that this plugin provides or implements.
Overrides
name
name:
string
Display name of the plugin.
Overrides
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