Class ClientPluginRegistry

Index

Constructors

Methods

register unregister reload list get resetForTest describe dispatchZoneEvent dispatchPreTick dispatchPostTick dispatchBossSpawn dispatchBossEnd dispatchLootDrop dispose statsFor

Constructors

constructor

new ClientPluginRegistry(
options?: ClientPluginRegistryOptions,
): ClientPluginRegistry
Parameters
- Optionaloptions: ClientPluginRegistryOptions
Returns ClientPluginRegistry
- Defined in plugins/client-registry.ts:291

Methods

register

register(plugin: IClientPlugin): void
Parameters
- plugin: IClientPlugin
Returns void
- Defined in plugins/client-registry.ts:398

unregister

unregister(name: string): Promise<boolean>
Parameters
- name: string
Returns Promise<boolean>
- Defined in plugins/client-registry.ts:438

reload

reload(
    name: string,
    moduleSpecifier?: string,
    exportName?: string,
): Promise<PluginDescribeRow | null>
Parameters
- name: string
- OptionalmoduleSpecifier: string
- OptionalexportName: string
Returns Promise<PluginDescribeRow | null>
- Defined in plugins/client-registry.ts:486

list

list(): readonly IClientPlugin[]
Returns readonly IClientPlugin[]
- Defined in plugins/client-registry.ts:559

get

get(name: string): IClientPlugin | undefined
Parameters
- name: string
Returns IClientPlugin | undefined
- Defined in plugins/client-registry.ts:563

resetForTest

resetForTest(): Promise<void>
Returns Promise<void>
- Defined in plugins/client-registry.ts:574

describe

describe(): PluginDescribeRow[]
Returns PluginDescribeRow[]
- Defined in plugins/client-registry.ts:593

dispatchZoneEvent

dispatchZoneEvent(envelope: ZoneEventEnvelope): Promise<ClientEmittedEvents>
Parameters
- envelope: ZoneEventEnvelope
Returns Promise<ClientEmittedEvents>
- Defined in plugins/client-registry.ts:931

dispatchPreTick

dispatchPreTick(): Promise<ClientEmittedEvents>
Returns Promise<ClientEmittedEvents>
- Defined in plugins/client-registry.ts:989

dispatchPostTick

dispatchPostTick(): Promise<ClientEmittedEvents>
Returns Promise<ClientEmittedEvents>
- Defined in plugins/client-registry.ts:993

dispatchBossSpawn

dispatchBossSpawn(
zoneId: string,
boss: ZoneBossSpec,
): Promise<ClientEmittedEvents>
Parameters
- zoneId: string
- boss: ZoneBossSpec
Returns Promise<ClientEmittedEvents>
- Defined in plugins/client-registry.ts:997

dispatchBossEnd

dispatchBossEnd(
    zoneId: string,
    bossId: string,
    outcome: ZoneBossOutcome,
): Promise<ClientEmittedEvents>
Parameters
- zoneId: string
- bossId: string
- outcome: ZoneBossOutcome
Returns Promise<ClientEmittedEvents>
- Defined in plugins/client-registry.ts:1001

dispatchLootDrop

dispatchLootDrop(
    zoneId: string,
    bossId: string,
    items: readonly unknown[],
): Promise<ClientEmittedEvents>
Parameters
- zoneId: string
- bossId: string
- items: readonly unknown[]
Returns Promise<ClientEmittedEvents>
- Defined in plugins/client-registry.ts:1005

dispose

dispose(): Promise<void>
Returns Promise<void>
- Defined in plugins/client-registry.ts:1015

statsFor

statsFor(name: string): PluginOpsStats | undefined
Parameters
- name: string
Returns PluginOpsStats | undefined
- Defined in plugins/client-registry.ts:1043