Skip to main content

BaseDescriptor

Class

Base 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

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

IPluginDescriptor.description


id

id: string

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

Overrides

IPluginDescriptor.id


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

IPluginDescriptor.interfaces


name

name: string

Display name of the plugin.

Overrides

IPluginDescriptor.name

Methods

getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

IPluginDescriptor.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

IPluginDescriptor.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

IPluginDescriptor.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

IPluginDescriptor.isSame