Interface Request

Generated

from protobuf message SC2APIProtocol.Request

interface Request {
    id?: number;
    request: {
        createGame: RequestCreateGame;
        oneofKind: "createGame";
    } | {
        joinGame: RequestJoinGame;
        oneofKind: "joinGame";
    } | {
        oneofKind: "restartGame";
        restartGame: RequestRestartGame;
    } | {
        oneofKind: "startReplay";
        startReplay: RequestStartReplay;
    } | {
        leaveGame: RequestLeaveGame;
        oneofKind: "leaveGame";
    } | {
        oneofKind: "quickSave";
        quickSave: RequestQuickSave;
    } | {
        oneofKind: "quickLoad";
        quickLoad: RequestQuickLoad;
    } | {
        oneofKind: "quit";
        quit: RequestQuit;
    } | {
        gameInfo: RequestGameInfo;
        oneofKind: "gameInfo";
    } | {
        observation: RequestObservation;
        oneofKind: "observation";
    } | {
        action: RequestAction;
        oneofKind: "action";
    } | {
        obsAction: RequestObserverAction;
        oneofKind: "obsAction";
    } | {
        oneofKind: "step";
        step: RequestStep;
    } | {
        data: RequestData;
        oneofKind: "data";
    } | {
        oneofKind: "query";
        query: RequestQuery;
    } | {
        oneofKind: "saveReplay";
        saveReplay: RequestSaveReplay;
    } | {
        mapCommand: RequestMapCommand;
        oneofKind: "mapCommand";
    } | {
        oneofKind: "replayInfo";
        replayInfo: RequestReplayInfo;
    } | {
        availableMaps: RequestAvailableMaps;
        oneofKind: "availableMaps";
    } | {
        oneofKind: "saveMap";
        saveMap: RequestSaveMap;
    } | {
        oneofKind: "ping";
        ping: RequestPing;
    } | {
        debug: RequestDebug;
        oneofKind: "debug";
    } | {
        oneofKind: undefined;
    };
}

Properties

id? request

Properties

Optional id

id?: number

Generated

from protobuf field: optional uint32 id = 97;

request

request: {
    createGame: RequestCreateGame;
    oneofKind: "createGame";
} | {
    joinGame: RequestJoinGame;
    oneofKind: "joinGame";
} | {
    oneofKind: "restartGame";
    restartGame: RequestRestartGame;
} | {
    oneofKind: "startReplay";
    startReplay: RequestStartReplay;
} | {
    leaveGame: RequestLeaveGame;
    oneofKind: "leaveGame";
} | {
    oneofKind: "quickSave";
    quickSave: RequestQuickSave;
} | {
    oneofKind: "quickLoad";
    quickLoad: RequestQuickLoad;
} | {
    oneofKind: "quit";
    quit: RequestQuit;
} | {
    gameInfo: RequestGameInfo;
    oneofKind: "gameInfo";
} | {
    observation: RequestObservation;
    oneofKind: "observation";
} | {
    action: RequestAction;
    oneofKind: "action";
} | {
    obsAction: RequestObserverAction;
    oneofKind: "obsAction";
} | {
    oneofKind: "step";
    step: RequestStep;
} | {
    data: RequestData;
    oneofKind: "data";
} | {
    oneofKind: "query";
    query: RequestQuery;
} | {
    oneofKind: "saveReplay";
    saveReplay: RequestSaveReplay;
} | {
    mapCommand: RequestMapCommand;
    oneofKind: "mapCommand";
} | {
    oneofKind: "replayInfo";
    replayInfo: RequestReplayInfo;
} | {
    availableMaps: RequestAvailableMaps;
    oneofKind: "availableMaps";
} | {
    oneofKind: "saveMap";
    saveMap: RequestSaveMap;
} | {
    oneofKind: "ping";
    ping: RequestPing;
} | {
    debug: RequestDebug;
    oneofKind: "debug";
} | {
    oneofKind: undefined;
}

Type declaration

  • createGame: RequestCreateGame

    Game Setup

    Generated

    from protobuf field: SC2APIProtocol.RequestCreateGame create_game = 1;

  • oneofKind: "createGame"

Type declaration

  • joinGame: RequestJoinGame

    Generated

    from protobuf field: SC2APIProtocol.RequestJoinGame join_game = 2;

  • oneofKind: "joinGame"

Type declaration

  • oneofKind: "restartGame"
  • restartGame: RequestRestartGame

    Generated

    from protobuf field: SC2APIProtocol.RequestRestartGame restart_game = 3;

Type declaration

  • oneofKind: "startReplay"
  • startReplay: RequestStartReplay

    Generated

    from protobuf field: SC2APIProtocol.RequestStartReplay start_replay = 4;

Type declaration

  • leaveGame: RequestLeaveGame

    Generated

    from protobuf field: SC2APIProtocol.RequestLeaveGame leave_game = 5;

  • oneofKind: "leaveGame"

Type declaration

  • oneofKind: "quickSave"
  • quickSave: RequestQuickSave

    Generated

    from protobuf field: SC2APIProtocol.RequestQuickSave quick_save = 6;

Type declaration

  • oneofKind: "quickLoad"
  • quickLoad: RequestQuickLoad

    Generated

    from protobuf field: SC2APIProtocol.RequestQuickLoad quick_load = 7;

Type declaration

  • oneofKind: "quit"
  • quit: RequestQuit

    Generated

    from protobuf field: SC2APIProtocol.RequestQuit quit = 8;

Type declaration

  • gameInfo: RequestGameInfo

    During Game

    Generated

    from protobuf field: SC2APIProtocol.RequestGameInfo game_info = 9;

  • oneofKind: "gameInfo"

Type declaration

  • observation: RequestObservation

    Generated

    from protobuf field: SC2APIProtocol.RequestObservation observation = 10;

  • oneofKind: "observation"

Type declaration

  • action: RequestAction

    Generated

    from protobuf field: SC2APIProtocol.RequestAction action = 11;

  • oneofKind: "action"

Type declaration

  • obsAction: RequestObserverAction

    Generated

    from protobuf field: SC2APIProtocol.RequestObserverAction obs_action = 21;

  • oneofKind: "obsAction"

Type declaration

  • oneofKind: "step"
  • step: RequestStep

    Generated

    from protobuf field: SC2APIProtocol.RequestStep step = 12;

Type declaration

  • data: RequestData

    Generated

    from protobuf field: SC2APIProtocol.RequestData data = 13;

  • oneofKind: "data"

Type declaration

  • oneofKind: "query"
  • query: RequestQuery

    Generated

    from protobuf field: SC2APIProtocol.RequestQuery query = 14;

Type declaration

  • oneofKind: "saveReplay"
  • saveReplay: RequestSaveReplay

    Generated

    from protobuf field: SC2APIProtocol.RequestSaveReplay save_replay = 15;

Type declaration

  • mapCommand: RequestMapCommand

    Generated

    from protobuf field: SC2APIProtocol.RequestMapCommand map_command = 22;

  • oneofKind: "mapCommand"

Type declaration

  • oneofKind: "replayInfo"
  • replayInfo: RequestReplayInfo

    Other.

    Generated

    from protobuf field: SC2APIProtocol.RequestReplayInfo replay_info = 16;

Type declaration

  • availableMaps: RequestAvailableMaps

    Generated

    from protobuf field: SC2APIProtocol.RequestAvailableMaps available_maps = 17;

  • oneofKind: "availableMaps"

Type declaration

  • oneofKind: "saveMap"
  • saveMap: RequestSaveMap

    Generated

    from protobuf field: SC2APIProtocol.RequestSaveMap save_map = 18;

Type declaration

  • oneofKind: "ping"
  • ping: RequestPing

    Debugging

    Generated

    from protobuf field: SC2APIProtocol.RequestPing ping = 19;

Type declaration

  • debug: RequestDebug

    Generated

    from protobuf field: SC2APIProtocol.RequestDebug debug = 20;

  • oneofKind: "debug"

Type declaration

  • oneofKind: undefined

Generated

from protobuf oneof: request

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc