Interface GameMetadata

This is for data that does not change once a game starts.

interface GameMetadata {
    characterAssignments: Readonly<Tuple<null | number, 2 | 3 | 4 | 5 | 6>>;
    characterMetadata: Readonly<Tuple<number, 2 | 3 | 4 | 5 | 6>>;
    hardVariant: boolean;
    hasCustomSeed: boolean;
    minEfficiency: number;
    options: Options;
    ourPlayerIndex: PlayerIndex;
    ourUsername: string;
    playerNames: Readonly<Tuple<string, 2 | 3 | 4 | 5 | 6>>;
    seed: string;
}

Properties

characterAssignments characterMetadata hardVariant hasCustomSeed minEfficiency options ourPlayerIndex ourUsername playerNames seed

Properties

ReadonlycharacterAssignments

characterAssignments: Readonly<Tuple<null | number, 2 | 3 | 4 | 5 | 6>>

ReadonlycharacterMetadata

characterMetadata: Readonly<Tuple<number, 2 | 3 | 4 | 5 | 6>>

ReadonlyhardVariant

hardVariant: boolean

Whether or not this is considered a "hard" variant by the H-Group.

ReadonlyhasCustomSeed

hasCustomSeed: boolean

ReadonlyminEfficiency

minEfficiency: number

The minimum efficiency required in order to get a perfect score in the chosen variant.

Readonlyoptions

options: Options

ReadonlyourPlayerIndex

ourPlayerIndex: PlayerIndex

If in a game, equal to the player index that we correspond to. If spectating an ongoing game or a replay, equal to the player index that we are observing from.

ReadonlyourUsername

ourUsername: string

ReadonlyplayerNames

playerNames: Readonly<Tuple<string, 2 | 3 | 4 | 5 | 6>>

Readonlyseed

seed: string

Settings

Member Visibility

On This Page

Properties