Class WorkerImportPluginEvent

Emitted when a plugin is imported to be loaded.

Hierarchy

CancelableEvent
- WorkerImportPluginEvent

Index

Properties

eventName canceled eventName plugin

Accessors

Methods

cancel setPlugin

Constructors

Properties

`Static` eventName

eventName: "worker.importplugin" = ...

canceled

canceled: boolean

eventName

eventName: "worker.importplugin" = ...

`Readonly` plugin

plugin: ImportedPlugin<typeof WorkerPlugin | typeof RoomPlugin>

The plugin that has been imported.

Accessors

alteredPlugin

get alteredPlugin(): ImportedPlugin<typeof WorkerPlugin | typeof RoomPlugin>
The plugin that will be imported/used instead, if altered with setPlugin.

Returns ImportedPlugin<typeof WorkerPlugin | typeof RoomPlugin>
- Defined in src/api/events/worker/ImportPlugin.ts:27

Methods

cancel

cancel(): void
Returns void
Inherited from CancelableEvent.cancel
- Defined in node_modules/@skeldjs/events/dist/lib/CancelableEvent.d.ts:5

setPlugin

setPlugin(plugin: ImportedPlugin<typeof WorkerPlugin | typeof RoomPlugin>): void
Change the plugin that will be imported/used.
Parameters
- plugin: ImportedPlugin<typeof WorkerPlugin | typeof RoomPlugin>
  
  The plugin to import/use instead.
Returns void
- Defined in src/api/events/worker/ImportPlugin.ts:35

Constructors

constructor

new WorkerImportPluginEvent(plugin: ImportedPlugin<typeof WorkerPlugin | typeof RoomPlugin>): WorkerImportPluginEvent
Parameters
- plugin: ImportedPlugin<typeof WorkerPlugin | typeof RoomPlugin>
  
  The plugin that has been imported.
Returns WorkerImportPluginEvent
Overrides CancelableEvent.constructor
- Defined in src/api/events/worker/ImportPlugin.ts:13

Generated using TypeDoc