Class BaseGameEvent<T>

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

Type Parameters

Hierarchy (View Summary)

BaseEvent<T>
- BaseGameEvent

Index

Constructors

constructor

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

Properties

msg

msg: string

timestamp

timestamp: string = ...

type

type: ValueOf<
    {
        CHAT_MESSAGE: "chat-message";
        ENTITY_KILLED: "entity-killed";
        LOG_LINE: "log";
        PLAYER_CONNECTED: "player-connected";
        PLAYER_DEATH: "player-death";
        PLAYER_DISCONNECTED: "player-disconnected";
    },
>

Methods

toJSON

toJSON(optionOverrides?: ClassTransformOptions): Record<string, any>
Parameters
- OptionaloptionOverrides: ClassTransformOptions
Returns Record<string, any>
Inherited from BaseEvent.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 BaseEvent.validate
- Defined in lib-util/dist/TakaroDTO.d.ts:20

Class BaseGameEvent<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BaseGameEvent<T>

Properties

msg

timestamp

type

Methods

toJSON

Parameters

Returns Record<string, any>

validate

Parameters

Returns Promise<void>

Throws

Settings

On This Page