Class GameEventService

Service to allow components to communicate with eachother through events

Index

Constructors

Methods

addGameEventListener dispatchGameEvent switchPage

Constructors

constructor

new GameEventService(): GameEventService
Returns GameEventService

Methods

addGameEventListener

addGameEventListener<T>(
gameEvent: SwitchPage,
callback: (event: T) => void,
): void
Listen for a game event and execute a function when it occurs
Type Parameters
- T
  Type used for the event data
Parameters
- gameEvent: SwitchPage
  Kind of game event to listen for
- callback: (event: T) => void
  Function to call when the game event occurs. Will get the event data as an argument.
Returns void
- Defined in src/web/src/services/GameEventService.ts:24

`Private`dispatchGameEvent

dispatchGameEvent<T>(gameEvent: SwitchPage, data?: T): void
Dispatch a game event
Type Parameters
- T
  Type used for the event data
Parameters
- gameEvent: SwitchPage
  Kind of game event to dispatch
- Optionaldata: T
  Event data to send along with the dispatch
Returns void
- Defined in src/web/src/services/GameEventService.ts:52

switchPage

switchPage(page: Canvas): void
Dispatch a Switch Page event
Parameters
- page: Canvas
  Page to switch to
Returns void
- Defined in src/web/src/services/GameEventService.ts:38