Class EventBus<T, G>

EventBus class for managing event listeners and dispatching events.

Type Parameters

T extends O
A record mapping event names to their payload types.
G extends O
The game state type.

Index

Constructors

Methods

Constructors

constructor

new EventBus<T, G>(): EventBus<T, G>
Type Parameters
- T extends O
- G extends O
Returns EventBus<T, G>

Methods

emit

emit<K>(eventName, server, payload): Promise<boolean>
Dispatches an event to all registered listeners. Listeners with the same priority are executed concurrently. Propagation stops if any listener returns false.
Type Parameters
- K extends string | number | symbol
  The event name type.
Parameters
- eventName: K
  The name of the event to emit.
- server: ServerBase<G>
  The server instance.
- payload: T[K]
  The data associated with the event.
Returns Promise<boolean>
A promise that resolves to true if all listeners returned true, or false otherwise.
- Defined in tools/EventBus.ts:162

off

off<K>(eventName, listenerOrId): void
Removes a listener for a specific event. Can remove by listener function or by listener id.
Type Parameters
- K extends string | number | symbol
Parameters
- eventName: K
  The name of the event.
- listenerOrId: number | ListenerFunction<T[K], G>
  The listener function or its unique identifier.
Returns void
- Defined in tools/EventBus.ts:139

on

on<K>(eventName, listener, priority?): number
Adds a listener for a specific event.
Type Parameters
- K extends string | number | symbol
Parameters
- eventName: K
  The name of the event to listen for.
- listener: ListenerFunction<T[K], G>
  The callback function.
- Optionalpriority: number = 0
  The priority of the listener. Higher priority listeners are executed first.
Returns number
A unique identifier for the listener.
- Defined in tools/EventBus.ts:119