IPluginDescriptor
ClassDescriptor exposing a plugin's id, name, description, dependencies, and exported interfaces.
Index
Example
// IPluginDescriptor exposes metadata about a registered plugin.
// Properties:
// id (readonly string) — unique plugin identifier
// name (readonly string) — human-readable name
// description (readonly string) — short description
// dependencies (readonly InterfaceId[]) — interfaces the plugin requires
// interfaces (readonly InterfaceId[]) — interfaces the plugin provides
const descriptors = this.pluginSystem.descriptors;
const count = Math.min(descriptors.length, 5);
console.log(`Total registered plugin descriptors: ${descriptors.length}`);
for (let i = 0; i < count; i++) {
const desc = descriptors[i];
console.log(` [${i}] id=${desc.id}, name=${desc.name}`);
}
Extends
Extended by
Properties
dependencies
readonlydependencies:InterfaceId[]
List of interface IDs that this plugin depends on.
description
readonlydescription:string
Human-readable description of the plugin.
id
readonlyid:string
Unique identifier string for the plugin.
intendedPlatforms
readonlyintendedPlatforms:TargetPlatform[]
Array of target platforms (Snapchat, Spectacles) where the plugin described by this descriptor is intended to run.
interfaces
readonlyinterfaces:InterfaceId[]
List of interface IDs that this plugin implements or exposes.
name
readonlyname:string
Display name of the plugin.
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