Interface EventHandlerInterface<Controllers, ResponseMessage>

Class for validating and merging incoming events

interface EventHandlerInterface<
    Controllers extends IndexedControllers,
    ResponseMessage extends Message,
> {
    merge(
        this: void,
        controllers: Controllers,
        sourceHandler: number,
        incomingEvent: undefined | ResponseMessage,
        data: undefined | Record<string, Serializable>,
    ): void;
    validateEvent(
        this: void,
        controllers: Controllers,
        sourceHandler: number,
        event: ResponseMessage,
    ): undefined | ResponseMessage;
}

Type Parameters

Controllers extends IndexedControllers
the state controllers for this game
ResponseMessage extends Message
the response messages this game expects

Index

Methods

merge validateEvent

Methods

merge

merge(
    this: void,
    controllers: Controllers,
    sourceHandler: number,
    incomingEvent: undefined | ResponseMessage,
    data: undefined | Record<string, Serializable>,
): void
Consolidate an incoming event with the game state
Parameters
- this: void
- controllers: Controllers
  the current state
- sourceHandler: number
  the handler or player generating the event
- incomingEvent: undefined | ResponseMessage
  the changing event
- data: undefined | Record<string, Serializable>
Returns void
- Defined in libs/core/src/games/event-handler-interface.ts:28

validateEvent

validateEvent(
    this: void,
    controllers: Controllers,
    sourceHandler: number,
    event: ResponseMessage,
): undefined | ResponseMessage
Tells whether the incoming event is valid or not and makes default moves for the players
Parameters
- this: void
- controllers: Controllers
  the current game state
- sourceHandler: number
  the handler or player the event is coming in from
- event: ResponseMessage
  the incoming event
Returns undefined | ResponseMessage
undefined if the event is to be ignored or otherwise the event that should be merged
- Defined in libs/core/src/games/event-handler-interface.ts:20

Interface EventHandlerInterface<Controllers, ResponseMessage>

Type Parameters

Index

Methods

Methods

merge

Parameters

Returns void

validateEvent

Parameters

Returns undefined | ResponseMessage

Settings

On This Page