Interface: Plugin<N, S>

Defined in: core/types.ts:134

A plugin adds a feature that does not draw on the canvas. It is also a configuration section.

Extends

• Section<N, S>

Extended by

• PanelPlugin

Type Parameters

Type Parameter	Default type
N extends string	string
S extends Schema	Schema

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
name	readonly	N	The unique name of the section. It is the key in the configuration document.	Section.name	config/types.ts:56
schema	readonly	S	The fields of the section.	Section.schema	config/types.ts:58

Methods

configure()?

optional configure(config, theme): void;

Defined in: core/types.ts:139

Gets the resolved values of the section after each change. The engine does not call it while enabled is false.

Parameters

Parameter	Type
config	EffectConfig<S>
theme	ThemeConfig

Returns

void

---

destroy()?

optional destroy(): void;

Defined in: core/types.ts:141

Releases all resources.

Returns

void

---

setup()

setup(context): void;

Defined in: core/types.ts:137

Gets the services of the engine. The engine calls it one time.

Parameters

Parameter	Type
context	PluginContext

Returns

void