Takaro - v0.4.9
    Preparing search index...

    Class IGamePlayer

    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)

    Index

    Constructors

    constructor

    Properties

    epicOnlineServicesId? gameId ip? name ping? platformId? steamId? xboxLiveId?

    Methods

    toJSON validate

    Constructors

    Properties

    epicOnlineServicesId?: string
    gameId: string

    Unique identifier for this player, as used by the game

    ip?: string
    name: string

    The players username

    ping?: number
    platformId?: string
    steamId?: string
    xboxLiveId?: string

    Methods

    • Parameters

      • OptionaloptionOverrides: ClassTransformOptions

      Returns Record<string, any>

    • Validates the DTO instance

      Parameters

      • OptionalextraOpts: ValidatorOptions

      Returns Promise<void>

      if validation fails

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods