Interface RequestJoinGame

If successful, puts the game into the status: in_game. Will be able to request actions, observations and step the game.

Generated

from protobuf message SC2APIProtocol.RequestJoinGame

interface RequestJoinGame {
    clientPorts?: PortSet[];
    hostIp?: string;
    options?: InterfaceOptions;
    participation: {
        oneofKind: "race";
        race: Race;
    } | {
        observedPlayerId: number;
        oneofKind: "observedPlayerId";
    } | {
        oneofKind: undefined;
    };
    playerName?: string;
    serverPorts?: PortSet;
    sharedPort?: number;
}

Properties

clientPorts? hostIp? options? participation playerName? serverPorts? sharedPort?

Properties

Optional clientPorts

clientPorts?: PortSet[]

Generated

from protobuf field: repeated SC2APIProtocol.PortSet client_ports = 5;

Optional hostIp

hostIp?: string

Generated

from protobuf field: optional string host_ip = 8;

Optional options

options?: InterfaceOptions

Generated

from protobuf field: optional SC2APIProtocol.InterfaceOptions options = 3;

participation

participation: {
    oneofKind: "race";
    race: Race;
} | {
    observedPlayerId: number;
    oneofKind: "observedPlayerId";
} | {
    oneofKind: undefined;
}

Type declaration

  • oneofKind: "race"
  • race: Race

    Generated

    from protobuf field: SC2APIProtocol.Race race = 1;

Type declaration

  • observedPlayerId: number

    Generated

    from protobuf field: uint32 observed_player_id = 2;

  • oneofKind: "observedPlayerId"

Type declaration

  • oneofKind: undefined

Generated

from protobuf oneof: participation

Optional playerName

playerName?: string

Generated

from protobuf field: optional string player_name = 7;

Optional serverPorts

serverPorts?: PortSet

Generated

from protobuf field: optional SC2APIProtocol.PortSet server_ports = 4;

Optional sharedPort

sharedPort?: number

Currently only a singe client is supported.

Generated

from protobuf field: optional int32 shared_port = 6;

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc