W3Booster SDK 4.8.0
    Preparing search index...

    Interface Match

    interface Match {
        broadcasterPlayerId?: string;
        endedAt?: string;
        gameDataId?: string;
        gameName?: string;
        gameSpeed?: number;
        gameTime: number;
        gameVersion?: string;
        id: string;
        isObserver?: boolean;
        isReforged?: boolean;
        isReplay?: boolean;
        map?: string;
        mode: string;
        outcomes?: Readonly<Record<string, "won" | "lost" | "draw">>;
        paused?: boolean;
        realBroadcasterPlayerId?: string;
        realm?: string;
        result?: { outcome: "won" | "lost"; playerId: string };
        startedAt?: string;
        status: MatchStatus;
    }
    Index
    broadcasterPlayerId? endedAt? gameDataId? gameName? gameSpeed? gameTime gameVersion? id isObserver? isReforged? isReplay? map? mode outcomes? paused? realBroadcasterPlayerId? realm? result? startedAt? status
    broadcasterPlayerId?: string
    endedAt?: string

    Authoritative ISO-8601 completion time when supplied by the platform.

    gameDataId?: string

    Exact generated catalog/artwork revision of the recorder. Absent when unavailable.

    gameName?: string

    Observed lobby name; omitted when unavailable.

    gameSpeed?: number

    Observed simulation game seconds per real second (0..64), not the requested replay speed. Zero while paused/finished; omitted when no fresh clock observation is available.

    gameTime: number

    Elapsed in-game time in whole seconds, excluding paused time.

    gameVersion?: string
    id: string

    Stable match identity. Empty only while status is none.

    isObserver?: boolean
    isReforged?: boolean
    isReplay?: boolean
    map?: string

    Human-readable, display-ready map name. Producers decode transport escaping before SDK delivery.

    mode: string
    outcomes?: Readonly<Record<string, "won" | "lost" | "draw">>

    Explicit participant results. Self-play is restricted to the local player; observer/replay results may be partial.

    paused?: boolean
    realBroadcasterPlayerId?: string
    realm?: string

    Recorder realm, e.g. Reforged, W3Champions, W3Champions@EU or W3Champions@NA. Independent of graphics mode.

    result?: { outcome: "won" | "lost"; playerId: string }

    Recorder-confirmed outcome for the actual local player; absent when unknown, observing, or replaying.

    startedAt?: string

    ISO-8601 timestamp serialized by the API.

    status: MatchStatus

    Settings

    On This Page
    Properties