Class HookRegistry<TArgs>

Type Parameters

TArgs extends unknown[]

Hierarchy (View Summary)

HookRegistry
- CombatHooks
- BattleHooks

Index

Constructors

Accessors

Methods

clear emit off offSource on

Constructors

constructor

new HookRegistry<TArgs extends unknown[]>(): HookRegistry<TArgs>
Type Parameters
- TArgs extends unknown[]
Returns HookRegistry<TArgs>

Accessors

size

get size(): number
how many handlers are registered, across every event

Returns number
- Defined in src/core/Hooks.ts:64

Methods

clear

clear(): void
Returns void
- Defined in src/core/Hooks.ts:68

emit

emit(event: string, ...args: TArgs): void
runs every handler registered for event, in registration order
Parameters
- event: string
- ...args: TArgs
Returns void
- Defined in src/core/Hooks.ts:55

off

off(handler: (...args: TArgs) => void): void
removes one specific handler; offSource is the usual way, this is for a one-off
Parameters
- handler: (...args: TArgs) => void
Returns void
- Defined in src/core/Hooks.ts:45

offSource

offSource(source: unknown): void
removes every hook registered with this source - a fainted creature's ability leaving
Parameters
- source: unknown
Returns void
- Defined in src/core/Hooks.ts:50

on

on(event: string, handler: (...args: TArgs) => void, source?: unknown): void
Parameters
- event: string
- handler: (...args: TArgs) => void
- Optionalsource: unknown
Returns void
- Defined in src/core/Hooks.ts:40