Class BasePlugin`Abstract`

Classe base per tutti i plugin di ShogunCore Fornisce funzionalità comuni e implementazione base dell'interfaccia ShogunPlugin

Hierarchy (View Summary)

EventEmitter
- BasePlugin

Implements

ShogunPlugin

Index

Constructors

Properties

_category? core description? name version

Methods

assertInitialized destroy emit initialize off on once removeAllListeners

Constructors

constructor

new BasePlugin(): BasePlugin
Returns BasePlugin
Inherited from EventEmitter.constructor

Properties

`Optional`_category

_category?: PluginCategory

Categoria del plugin

`Protected`core

core: null | ShogunCore = null

Riferimento all'istanza di ShogunCore

`Optional`description

description?: string

Descrizione opzionale del plugin

`Abstract`name

name: string

Nome univoco del plugin - deve essere implementato dalle sottoclassi

`Abstract`version

version: string

Versione del plugin - deve essere implementata dalle sottoclassi

Methods

`Protected`assertInitialized

assertInitialized(): ShogunCore
Verifica che il plugin sia stato inizializzato prima di usare il core

Returns ShogunCore
L'istanza di ShogunCore non null

Throws
Error se il plugin non è stato inizializzato

destroy

destroy(): void
Distrugge il plugin e libera le risorse

Returns void
Implementation of ShogunPlugin.destroy

emit

emit(event: EventType, data?: unknown): boolean
Emits an event with arguments
Parameters
- event: EventType
- Optionaldata: unknown
Returns boolean
Inherited from EventEmitter.emit

initialize

initialize(core: ShogunCore): void
Inizializza il plugin con un'istanza di ShogunCore
Parameters
- core: ShogunCore
  Istanza di ShogunCore
Returns void
Implementation of ShogunPlugin.initialize

off

off(event: EventType, listener: (data: unknown) => void): void
Removes an event listener
Parameters
- event: EventType
- listener: (data: unknown) => void
Returns void
Inherited from EventEmitter.off

on

on(event: EventType, listener: (data: unknown) => void): void
Registers an event listener
Parameters
- event: EventType
- listener: (data: unknown) => void
Returns void
Inherited from EventEmitter.on

once

once(event: EventType, listener: (data: unknown) => void): void
Registers a one-time event listener
Parameters
- event: EventType
- listener: (data: unknown) => void
Returns void
Inherited from EventEmitter.once

removeAllListeners

removeAllListeners(event?: EventType): void
Removes all listeners for an event or all events
Parameters
- Optionalevent: EventType
Returns void
Inherited from EventEmitter.removeAllListeners