Class ClientBroadcastEvent

Hierarchy

CancelableEvent
- ClientBroadcastEvent

Implements

ClientEvent

Index

Properties

eventName canceled client eventName gameData payload room

Accessors

alteredGameData

Methods

cancel setGameData

Constructors

Properties

`Static` eventName

eventName: "client.broadcast" = ...

canceled

canceled: boolean

`Readonly` client

client: Connection

The client that connected to the server, fully identified.

eventName

eventName: "client.broadcast" = ...

`Readonly` gameData

gameData: BaseGameDataMessage[]

`Readonly` payload

payload: BaseRootMessage[]

`Readonly` room

room: Room

Accessors

alteredGameData

get alteredGameData(): BaseGameDataMessage[]
Returns BaseGameDataMessage[]
- Defined in src/api/events/client/ClientBroadcast.ts:26

Methods

cancel

cancel(): void
Returns void
Inherited from CancelableEvent.cancel
- Defined in node_modules/@skeldjs/events/dist/lib/CancelableEvent.d.ts:5

setGameData

setGameData(gamedata: BaseGameDataMessage[]): void
Parameters
- gamedata: BaseGameDataMessage[]
Returns void
- Defined in src/api/events/client/ClientBroadcast.ts:30

Constructors

constructor

new ClientBroadcastEvent(room: Room, client: Connection, gameData: BaseGameDataMessage[], payload: BaseRootMessage[]): ClientBroadcastEvent
Parameters
- room: Room
- client: Connection
  
  The client that connected to the server, fully identified.
- gameData: BaseGameDataMessage[]
- payload: BaseRootMessage[]
Returns ClientBroadcastEvent
Overrides CancelableEvent.constructor
- Defined in src/api/events/client/ClientBroadcast.ts:12

Generated using TypeDoc