Skip to main content

EventDispatcher <T>

@deprecated: Use EventEmitter will be removed in v0.29.0

Implements

Eventable

Index

Constructors

constructor

Methods

Constructors

constructor

new EventDispatcher<T>(): EventDispatcher<T>

Type parameters
- T = any
Returns EventDispatcher<T>

Methods

publicclear

clear(): void

Clears any existing handlers or wired event dispatchers on this event dispatcher
Returns void

publicemit

emit(eventName: string, event: GameEvent<T, T>): void

Implementation of Eventable.emit
Emits an event for target
Parameters
- eventName: string
  The name of the event to publish
- event: GameEvent<T, T>
  Optionally pass an event data object to the handler
Returns void

publicoff

off(eventName: string, handler?: (event: GameEvent<T, T>) => void): void

Implementation of Eventable.off
Unsubscribe an event handler(s) from an event. If a specific handler is specified for an event, only that handler will be unsubscribed. Otherwise all handlers will be unsubscribed for that event.
Parameters
- eventName: string
  The name of the event to unsubscribe
- optionalhandler: (event: GameEvent<T, T>) => void
  Optionally the specific handler to unsubscribe
Returns void

publicon

on(eventName: string, handler: (event: GameEvent<T, T>) => void): void

Implementation of Eventable.on
Subscribe an event handler to a particular event name, multiple handlers per event name are allowed.
Parameters
- eventName: string
  The name of the event to subscribe to
- handler: (event: GameEvent<T, T>) => void
  The handler callback to fire on this event
Returns void

publiconce

once(eventName: string, handler: (event: GameEvent<T, T>) => void): void

Implementation of Eventable.once
Once listens to an event one time, then unsubscribes from that event
Parameters
- eventName: string
  The name of the event to subscribe to once
- handler: (event: GameEvent<T, T>) => void
  The handler of the event that will be auto unsubscribed
Returns void

publicunwire

unwire(eventDispatcher: EventDispatcher<any>): void

Unwires this event dispatcher from another
Parameters
- eventDispatcher: EventDispatcher<any>
Returns void

publicwire

wire(eventDispatcher: EventDispatcher<any>): void

Wires this event dispatcher to also receive events from another
Parameters
- eventDispatcher: EventDispatcher<any>
Returns void