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

  • T

Hierarchy (View Summary)

Constructors

constructor

Properties

msg timestamp type

Methods

toJSON validate

Constructors

constructor

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(): Record<string, any>

  • Returns Record<string, any>

validate

  • validate(extraOpts?: ValidatorOptions): Promise<void>

  • Validates the DTO instance

    Parameters

    • OptionalextraOpts: ValidatorOptions

    Returns Promise<void>

    Throws

    if validation fails

Settings

Member Visibility

On This Page

Constructors
Properties
Methods