Interface RequestCreateGame

If successful, puts the game into the status: init_game. The next expected request should be RequestJoinGame. Can also quit (exit).

Generated

from protobuf message SC2APIProtocol.RequestCreateGame

interface RequestCreateGame {
    disableFog?: boolean;
    map: {
        localMap: LocalMap;
        oneofKind: "localMap";
    } | {
        battlenetMapName: string;
        oneofKind: "battlenetMapName";
    } | {
        oneofKind: undefined;
    };
    playerSetup: PlayerSetup[];
    randomSeed?: number;
    realtime?: boolean;
}

Properties

disableFog? map playerSetup randomSeed? realtime?

Properties

Optional disableFog

disableFog?: boolean

Generated

from protobuf field: optional bool disable_fog = 4;

map

map: {
    localMap: LocalMap;
    oneofKind: "localMap";
} | {
    battlenetMapName: string;
    oneofKind: "battlenetMapName";
} | {
    oneofKind: undefined;
}

Type declaration

  • localMap: LocalMap

    Generated

    from protobuf field: SC2APIProtocol.LocalMap local_map = 1;

  • oneofKind: "localMap"

Type declaration

  • battlenetMapName: string

    Generated

    from protobuf field: string battlenet_map_name = 2;

  • oneofKind: "battlenetMapName"

Type declaration

  • oneofKind: undefined

Generated

from protobuf oneof: Map

playerSetup

playerSetup: PlayerSetup[]

Generated

from protobuf field: repeated SC2APIProtocol.PlayerSetup player_setup = 3;

Optional randomSeed

randomSeed?: number

Generated

from protobuf field: optional uint32 random_seed = 5;

Optional realtime

realtime?: boolean

Generated

from protobuf field: optional bool realtime = 6;

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc