Interface Response

Generated

from protobuf message SC2APIProtocol.Response

interface Response {
    error: string[];
    id?: number;
    response: {
        createGame: ResponseCreateGame;
        oneofKind: "createGame";
    } | {
        joinGame: ResponseJoinGame;
        oneofKind: "joinGame";
    } | {
        oneofKind: "restartGame";
        restartGame: ResponseRestartGame;
    } | {
        oneofKind: "startReplay";
        startReplay: ResponseStartReplay;
    } | {
        leaveGame: ResponseLeaveGame;
        oneofKind: "leaveGame";
    } | {
        oneofKind: "quickSave";
        quickSave: ResponseQuickSave;
    } | {
        oneofKind: "quickLoad";
        quickLoad: ResponseQuickLoad;
    } | {
        oneofKind: "quit";
        quit: ResponseQuit;
    } | {
        gameInfo: ResponseGameInfo;
        oneofKind: "gameInfo";
    } | {
        observation: ResponseObservation;
        oneofKind: "observation";
    } | {
        action: ResponseAction;
        oneofKind: "action";
    } | {
        obsAction: ResponseObserverAction;
        oneofKind: "obsAction";
    } | {
        oneofKind: "step";
        step: ResponseStep;
    } | {
        data: ResponseData;
        oneofKind: "data";
    } | {
        oneofKind: "query";
        query: ResponseQuery;
    } | {
        oneofKind: "saveReplay";
        saveReplay: ResponseSaveReplay;
    } | {
        oneofKind: "replayInfo";
        replayInfo: ResponseReplayInfo;
    } | {
        availableMaps: ResponseAvailableMaps;
        oneofKind: "availableMaps";
    } | {
        oneofKind: "saveMap";
        saveMap: ResponseSaveMap;
    } | {
        mapCommand: ResponseMapCommand;
        oneofKind: "mapCommand";
    } | {
        oneofKind: "ping";
        ping: ResponsePing;
    } | {
        debug: ResponseDebug;
        oneofKind: "debug";
    } | {
        oneofKind: undefined;
    };
    status?: Status;
}

Properties

error id? response status?

Properties

error

error: string[]

Generated

from protobuf field: repeated string error = 98;

Optional id

id?: number

Generated

from protobuf field: optional uint32 id = 97;

response

response: {
    createGame: ResponseCreateGame;
    oneofKind: "createGame";
} | {
    joinGame: ResponseJoinGame;
    oneofKind: "joinGame";
} | {
    oneofKind: "restartGame";
    restartGame: ResponseRestartGame;
} | {
    oneofKind: "startReplay";
    startReplay: ResponseStartReplay;
} | {
    leaveGame: ResponseLeaveGame;
    oneofKind: "leaveGame";
} | {
    oneofKind: "quickSave";
    quickSave: ResponseQuickSave;
} | {
    oneofKind: "quickLoad";
    quickLoad: ResponseQuickLoad;
} | {
    oneofKind: "quit";
    quit: ResponseQuit;
} | {
    gameInfo: ResponseGameInfo;
    oneofKind: "gameInfo";
} | {
    observation: ResponseObservation;
    oneofKind: "observation";
} | {
    action: ResponseAction;
    oneofKind: "action";
} | {
    obsAction: ResponseObserverAction;
    oneofKind: "obsAction";
} | {
    oneofKind: "step";
    step: ResponseStep;
} | {
    data: ResponseData;
    oneofKind: "data";
} | {
    oneofKind: "query";
    query: ResponseQuery;
} | {
    oneofKind: "saveReplay";
    saveReplay: ResponseSaveReplay;
} | {
    oneofKind: "replayInfo";
    replayInfo: ResponseReplayInfo;
} | {
    availableMaps: ResponseAvailableMaps;
    oneofKind: "availableMaps";
} | {
    oneofKind: "saveMap";
    saveMap: ResponseSaveMap;
} | {
    mapCommand: ResponseMapCommand;
    oneofKind: "mapCommand";
} | {
    oneofKind: "ping";
    ping: ResponsePing;
} | {
    debug: ResponseDebug;
    oneofKind: "debug";
} | {
    oneofKind: undefined;
}

Type declaration

  • createGame: ResponseCreateGame

    Generated

    from protobuf field: SC2APIProtocol.ResponseCreateGame create_game = 1;

  • oneofKind: "createGame"

Type declaration

  • joinGame: ResponseJoinGame

    Generated

    from protobuf field: SC2APIProtocol.ResponseJoinGame join_game = 2;

  • oneofKind: "joinGame"

Type declaration

  • oneofKind: "restartGame"
  • restartGame: ResponseRestartGame

    Generated

    from protobuf field: SC2APIProtocol.ResponseRestartGame restart_game = 3;

Type declaration

  • oneofKind: "startReplay"
  • startReplay: ResponseStartReplay

    Generated

    from protobuf field: SC2APIProtocol.ResponseStartReplay start_replay = 4;

Type declaration

  • leaveGame: ResponseLeaveGame

    Generated

    from protobuf field: SC2APIProtocol.ResponseLeaveGame leave_game = 5;

  • oneofKind: "leaveGame"

Type declaration

  • oneofKind: "quickSave"
  • quickSave: ResponseQuickSave

    Generated

    from protobuf field: SC2APIProtocol.ResponseQuickSave quick_save = 6;

Type declaration

  • oneofKind: "quickLoad"
  • quickLoad: ResponseQuickLoad

    Generated

    from protobuf field: SC2APIProtocol.ResponseQuickLoad quick_load = 7;

Type declaration

  • oneofKind: "quit"
  • quit: ResponseQuit

    Generated

    from protobuf field: SC2APIProtocol.ResponseQuit quit = 8;

Type declaration

  • gameInfo: ResponseGameInfo

    Generated

    from protobuf field: SC2APIProtocol.ResponseGameInfo game_info = 9;

  • oneofKind: "gameInfo"

Type declaration

  • observation: ResponseObservation

    Generated

    from protobuf field: SC2APIProtocol.ResponseObservation observation = 10;

  • oneofKind: "observation"

Type declaration

  • action: ResponseAction

    Generated

    from protobuf field: SC2APIProtocol.ResponseAction action = 11;

  • oneofKind: "action"

Type declaration

  • obsAction: ResponseObserverAction

    Generated

    from protobuf field: SC2APIProtocol.ResponseObserverAction obs_action = 21;

  • oneofKind: "obsAction"

Type declaration

  • oneofKind: "step"
  • step: ResponseStep

    Generated

    from protobuf field: SC2APIProtocol.ResponseStep step = 12;

Type declaration

  • data: ResponseData

    Generated

    from protobuf field: SC2APIProtocol.ResponseData data = 13;

  • oneofKind: "data"

Type declaration

  • oneofKind: "query"
  • query: ResponseQuery

    Generated

    from protobuf field: SC2APIProtocol.ResponseQuery query = 14;

Type declaration

  • oneofKind: "saveReplay"
  • saveReplay: ResponseSaveReplay

    Generated

    from protobuf field: SC2APIProtocol.ResponseSaveReplay save_replay = 15;

Type declaration

  • oneofKind: "replayInfo"
  • replayInfo: ResponseReplayInfo

    Generated

    from protobuf field: SC2APIProtocol.ResponseReplayInfo replay_info = 16;

Type declaration

  • availableMaps: ResponseAvailableMaps

    Generated

    from protobuf field: SC2APIProtocol.ResponseAvailableMaps available_maps = 17;

  • oneofKind: "availableMaps"

Type declaration

  • oneofKind: "saveMap"
  • saveMap: ResponseSaveMap

    Generated

    from protobuf field: SC2APIProtocol.ResponseSaveMap save_map = 18;

Type declaration

  • mapCommand: ResponseMapCommand

    Generated

    from protobuf field: SC2APIProtocol.ResponseMapCommand map_command = 22;

  • oneofKind: "mapCommand"

Type declaration

  • oneofKind: "ping"
  • ping: ResponsePing

    Debugging

    Generated

    from protobuf field: SC2APIProtocol.ResponsePing ping = 19;

Type declaration

  • debug: ResponseDebug

    Generated

    from protobuf field: SC2APIProtocol.ResponseDebug debug = 20;

  • oneofKind: "debug"

Type declaration

  • oneofKind: undefined

Generated

from protobuf oneof: response

Optional status

status?: Status

Generated

from protobuf field: optional SC2APIProtocol.Status status = 99;

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc