Class GenericHandlerController<ResponseMessage, Handlers>

Allows for controlling the handlers

Type Parameters

ResponseMessage extends Message
the response messages this game expects
Handlers extends { [key: string]: any[] } & SystemHandlerParams
the custom event handlers that this game has

Hierarchy (View Summary)

AbstractController<undefined, HandlerControllerDependencies, PlayerHandlerState>
- GenericHandlerController

Index

Constructors

constructor

new GenericHandlerController<
    ResponseMessage extends Message,
    Handlers extends
        { [key: string]: any[] } & MessageHandlerParams & WaitingHandlerParams,
>(
    handlerProxy: GenericHandlerProxy<ResponseMessage, Handlers>,
    controllers: HandlerControllerDependencies,
): GenericHandlerController<ResponseMessage, Handlers>
Type Parameters
- ResponseMessage extends Message
- Handlers extends { [key: string]: any[] } & MessageHandlerParams & WaitingHandlerParams
Parameters
- handlerProxy: GenericHandlerProxy<ResponseMessage, Handlers>
- controllers: HandlerControllerDependencies
Returns GenericHandlerController<ResponseMessage, Handlers>
Overrides AbstractController.constructor
- Defined in libs/core/src/games/generic-handler-controller.ts:147

Properties

`Protected`controllers

controllers: HandlerControllerDependencies

`Protected`state

state: undefined

Accessors

count

get count(): number
Returns number
- Defined in libs/core/src/games/generic-handler-controller.ts:215

Methods

getFor

getFor(position: number): { count: number; position: number }
Parameters
- position: number
Returns { count: number; position: number }
Overrides AbstractController.getFor
- Defined in libs/core/src/games/generic-handler-controller.ts:151

handlerCall

handlerCall<Method extends string | number | symbol>(
    position: number,
    method: Method,
    ...args: Handlers[Method],
): void
Calls the handler chain at the specified position
Type Parameters
- Method extends string | number | symbol
Parameters
- position: number
  the position of the handler to call
- method: Method
  the event type to call
- ...args: Handlers[Method]
  the args to call with
Returns void
- Defined in libs/core/src/games/generic-handler-controller.ts:189

handlerCallAll

handlerCallAll<Method extends string | number | symbol>(
    method: Method,
    waitFor?: number[],
    ...args: Handlers[Method],
): void
Calls all the handlers and wait for a response
Type Parameters
- Method extends string | number | symbol
Parameters
- method: Method
  the event type to call
- waitFor: number[] = ...
- ...args: Handlers[Method]
  the args to call with
Returns void
- Defined in libs/core/src/games/generic-handler-controller.ts:210

handlerCallFirst

handlerCallFirst<Method extends string | number | symbol>(
    method: Method,
    numToWaitFor?: number,
    ...args: Handlers[Method],
): void
Calls all the handlers and waits for N to respond
Type Parameters
- Method extends string | number | symbol
Parameters
- method: Method
  the event type to call
- numToWaitFor: number = 1
  the number of handlers to wait for
- ...args: Handlers[Method]
  the args to call with
Returns void
- Defined in libs/core/src/games/generic-handler-controller.ts:200

message

message(position: number, message: Message): void
Send a message to a player
Parameters
- position: number
- message: Message
  the message to send
Returns void
- Defined in libs/core/src/games/generic-handler-controller.ts:162

messageAll

messageAll(message: Message): void
Send a message to all the players
Parameters
- message: Message
  the message to send
Returns void
- Defined in libs/core/src/games/generic-handler-controller.ts:170

messageOthers

messageOthers(excludedPosition: number, message: Message): void
Send a message to all the players minus the excluded
Parameters
- excludedPosition: number
  the player to not send to
- message: Message
  the message to send
Returns void
- Defined in libs/core/src/games/generic-handler-controller.ts:179

validate

validate(): void
Returns void
Inherited from AbstractController.validate
- Defined in libs/core/src/controllers/controller.ts:18

Class GenericHandlerController<ResponseMessage, Handlers>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns GenericHandlerController<ResponseMessage, Handlers>

Properties

Protectedcontrollers

Protectedstate

Accessors

count

Returns number

Methods

getFor

Parameters

Returns { count: number; position: number }

handlerCall

Type Parameters

Parameters

Returns void

handlerCallAll

Type Parameters

Parameters

Returns void

handlerCallFirst

Type Parameters

Parameters

Returns void

message

Parameters

Returns void

messageAll

Parameters

Returns void

messageOthers

Parameters

Returns void

validate

Returns void

Settings

On This Page

`Protected`controllers

`Protected`state