Class EventPlayerDisconnected

Generic Data Transfer Object, used widely in Takaro to pass data back and forth between components Allows validation of properties when instantiated and JSON (de)serialization

Hierarchy (View Summary)

BaseGameEvent<EventPlayerDisconnected>
- EventPlayerDisconnected

Index

Constructors

constructor

new EventPlayerDisconnected(
data?: Nullable<DeepPartial<EventPlayerDisconnected>>,
): EventPlayerDisconnected
Parameters
- Optionaldata: Nullable<DeepPartial<EventPlayerDisconnected>>
Returns EventPlayerDisconnected
Inherited from BaseGameEvent.constructor
- Defined in lib-util/dist/TakaroDTO.d.ts:14

Properties

msg

msg: string

player

player: IGamePlayer

timestamp

timestamp: string = ...

type

type: "player-disconnected" = GameEvents.PLAYER_DISCONNECTED

Methods

toJSON

toJSON(optionOverrides?: ClassTransformOptions): Record<string, any>
Parameters
- OptionaloptionOverrides: ClassTransformOptions
Returns Record<string, any>
Inherited from BaseGameEvent.toJSON
- Defined in lib-util/dist/TakaroDTO.d.ts:21

validate

validate(extraOpts?: ValidatorOptions): Promise<void>
Validates the DTO instance
Parameters
- OptionalextraOpts: ValidatorOptions
Returns Promise<void>
Throws
if validation fails
Inherited from BaseGameEvent.validate
- Defined in lib-util/dist/TakaroDTO.d.ts:20

Class EventPlayerDisconnected

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EventPlayerDisconnected

Properties

msg

player

timestamp

type

Methods

toJSON

Parameters

Returns Record<string, any>

validate

Parameters

Returns Promise<void>

Throws

Settings

On This Page