Interface MatchState<TSettings, TOverlayExtensions>

interface MatchState<
    TSettings extends object = JsonObject,
    TOverlayExtensions extends object = object,
> {
    application?: ApplicationState<TSettings>;
    capabilities: readonly Capability[];
    gameContext: GameContext;
    match: Match;
    overlay?: OverlayState<TOverlayExtensions>;
    players: readonly Player[];
    poiMode?: "live" | "initial";
    pois?: Readonly<Record<string, PointOfInterest>>;
}

Type Parameters

TSettings extends object = JsonObject
TOverlayExtensions extends object = object

Index

Properties

application? capabilities gameContext match overlay? players poiMode? pois?

Properties

`Optional` `Readonly`application

application?: ApplicationState<TSettings>

`Readonly`capabilities

capabilities: readonly Capability[]

`Readonly`gameContext

gameContext: GameContext

Always delivered, including idle and scope-free state.

`Readonly`match

match: Match

`Optional` `Readonly`overlay

overlay?: OverlayState<TOverlayExtensions>

`Readonly`players

players: readonly Player[]

`Optional` `Readonly`poiMode

poiMode?: "live" | "initial"

Self-play is a frozen game-start snapshot; only observer/replay may be live.

`Optional` `Readonly`pois

pois?: Readonly<Record<string, PointOfInterest>>

POIs under pois:read. Missing means unavailable, {} observed empty.