package SC2APIProtocol
Get desktop application:
View/edit binary Protocol Buffers messages
message
data.proto:12May not relevant: queueable (everything is queueable). May not be important: AbilSetId - marine stim, marauder stim. Stuff omitted: transient. Stuff that may be important: cost, range, Alignment, targetfilters.
Used in:
uint32 ability_id = 1
Stable ID.
string link_name = 2
Catalog name of the ability.
uint32 link_index = 3
Catalog index of the ability.
string button_name = 4
Name used for the command card. May not always be set.
string friendly_name = 5
A human friendly name when the button name or link name isn't descriptive.
string hotkey = 6
Hotkey. May not always be set.
uint32 remaps_to_ability_id = 7
This ability id may be represented by the given more generic id.
bool available = 8
If true, the ability may be used by this set of mods/map.
AbilityData.Target target = 9
Determines if a point is optional or required.
bool allow_minimap = 10
Can be cast in the minimap.
bool allow_autocast = 11
Autocast can be set.
bool is_building = 12
Requires placement to construct a building.
float footprint_radius = 13
Estimation of the footprint size. Need a better footprint.
bool is_instant_placement = 14
Placement next to an existing structure, e.g., an add-on like a Tech Lab.
float cast_range = 15
Range unit can cast ability without needing to approach target.
Used in:
Target_UNSET = 0
None = 1
Does not require a target.
Point = 2
Requires a target position.
Unit = 3
Requires a unit to target. Given by position using feature layers.
PointOrUnit = 4
Requires either a target point or target unit.
PointOrNone = 5
Requires either a target point or no target. (eg. building add-ons)
message
sc2api.proto:579Used in: ,
optional action_raw = 1
Populated if Raw interface is enabled.
optional action_feature_layer = 2
Populated if Feature Layer interface is enabled.
optional action_render = 3
Not implemented. Populated if Render interface is enabled.
optional action_ui = 4
Populated if Feature Layer or Render interface is enabled.
optional action_chat = 6
Chat messages as a player typing into the chat channel.
message
ui.proto:124Used in:
int32 unit_index = 1
message
sc2api.proto:587Used in:
ActionChat.Channel channel = 1
string message = 2
Used in:
Channel_UNSET = 0
Broadcast = 1
Team = 2
message
ui.proto:77Used in:
ActionControlGroup.ControlGroupAction action = 1
uint32 control_group_index = 2
Used in:
ControlGroupAction_UNSET = 0
Recall = 1
Equivalent to number hotkey. Replaces current selection with control group.
Set = 2
Equivalent to Control + number hotkey. Sets control group to current selection.
Append = 3
Equivalent to Shift + number hotkey. Adds current selection into control group.
SetAndSteal = 4
Equivalent to Control + Alt + number hotkey. Sets control group to current selection. Units are removed from other control groups.
AppendAndSteal = 5
Equivalent to Shift + Alt + number hotkey. Adds current selection into control group. Units are removed from other control groups.
message
sc2api.proto:597Used in:
uint64 unit_tag = 1
Only populated when using raw interface.
uint64 ability_id = 2
ActionResult result = 3
message
ui.proto:112Used in:
ActionMultiPanel.Type type = 1
int32 unit_index = 2
Used in:
Type_UNSET = 0
SingleSelect = 1
Click on icon
DeselectUnit = 2
Shift Click on icon
SelectAllOfType = 3
Control Click on icon.
DeselectAllOfType = 4
Control+Shift Click on icon.
message
sc2api.proto:624Used in:
uint32 player_id = 1
Not implemented. Value must be [1, 15]
message
sc2api.proto:628Used in:
repeated uint64 unit_tags = 1
message
sc2api.proto:616Used in:
optional world_pos = 1
float distance = 2
Distance between camera and terrain. Larger value zooms out camera. Defaults to standard camera distance if set to 0.
message
sc2api.proto:612Used in:
uint32 player_id = 1
0 to observe "Everyone"
message
ui.proto:128Used in:
int32 unit_index = 1
message
raw.proto:155Used in:
oneof action
unit_command = 1
camera_move = 2
toggle_autocast = 3
message
raw.proto:173Used in:
optional center_world_space = 1
message
raw.proto:177Used in:
int32 ability_id = 1
repeated uint64 unit_tags = 2
message
raw.proto:163Used in:
int32 ability_id = 1
oneof target
target_world_space_pos = 2
uint64 target_unit_tag = 3
repeated uint64 unit_tags = 4
bool queue_command = 5
Used in: , ,
ActionResult_UNSET = 0
Success = 1
NotSupported = 2
Error = 3
CantQueueThatOrder = 4
Retry = 5
Cooldown = 6
QueueIsFull = 7
RallyQueueIsFull = 8
NotEnoughMinerals = 9
NotEnoughVespene = 10
NotEnoughTerrazine = 11
NotEnoughCustom = 12
NotEnoughFood = 13
FoodUsageImpossible = 14
NotEnoughLife = 15
NotEnoughShields = 16
NotEnoughEnergy = 17
LifeSuppressed = 18
ShieldsSuppressed = 19
EnergySuppressed = 20
NotEnoughCharges = 21
CantAddMoreCharges = 22
TooMuchMinerals = 23
TooMuchVespene = 24
TooMuchTerrazine = 25
TooMuchCustom = 26
TooMuchFood = 27
TooMuchLife = 28
TooMuchShields = 29
TooMuchEnergy = 30
MustTargetUnitWithLife = 31
MustTargetUnitWithShields = 32
MustTargetUnitWithEnergy = 33
CantTrade = 34
CantSpend = 35
CantTargetThatUnit = 36
CouldntAllocateUnit = 37
UnitCantMove = 38
TransportIsHoldingPosition = 39
BuildTechRequirementsNotMet = 40
CantFindPlacementLocation = 41
CantBuildOnThat = 42
CantBuildTooCloseToDropOff = 43
CantBuildLocationInvalid = 44
CantSeeBuildLocation = 45
CantBuildTooCloseToCreepSource = 46
CantBuildTooCloseToResources = 47
CantBuildTooFarFromWater = 48
CantBuildTooFarFromCreepSource = 49
CantBuildTooFarFromBuildPowerSource = 50
CantBuildOnDenseTerrain = 51
CantTrainTooFarFromTrainPowerSource = 52
CantLandLocationInvalid = 53
CantSeeLandLocation = 54
CantLandTooCloseToCreepSource = 55
CantLandTooCloseToResources = 56
CantLandTooFarFromWater = 57
CantLandTooFarFromCreepSource = 58
CantLandTooFarFromBuildPowerSource = 59
CantLandTooFarFromTrainPowerSource = 60
CantLandOnDenseTerrain = 61
AddOnTooFarFromBuilding = 62
MustBuildRefineryFirst = 63
BuildingIsUnderConstruction = 64
CantFindDropOff = 65
CantLoadOtherPlayersUnits = 66
NotEnoughRoomToLoadUnit = 67
CantUnloadUnitsThere = 68
CantWarpInUnitsThere = 69
CantLoadImmobileUnits = 70
CantRechargeImmobileUnits = 71
CantRechargeUnderConstructionUnits = 72
CantLoadThatUnit = 73
NoCargoToUnload = 74
LoadAllNoTargetsFound = 75
NotWhileOccupied = 76
CantAttackWithoutAmmo = 77
CantHoldAnyMoreAmmo = 78
TechRequirementsNotMet = 79
MustLockdownUnitFirst = 80
MustTargetUnit = 81
MustTargetInventory = 82
MustTargetVisibleUnit = 83
MustTargetVisibleLocation = 84
MustTargetWalkableLocation = 85
MustTargetPawnableUnit = 86
YouCantControlThatUnit = 87
YouCantIssueCommandsToThatUnit = 88
MustTargetResources = 89
RequiresHealTarget = 90
RequiresRepairTarget = 91
NoItemsToDrop = 92
CantHoldAnyMoreItems = 93
CantHoldThat = 94
TargetHasNoInventory = 95
CantDropThisItem = 96
CantMoveThisItem = 97
CantPawnThisUnit = 98
MustTargetCaster = 99
CantTargetCaster = 100
MustTargetOuter = 101
CantTargetOuter = 102
MustTargetYourOwnUnits = 103
CantTargetYourOwnUnits = 104
MustTargetFriendlyUnits = 105
CantTargetFriendlyUnits = 106
MustTargetNeutralUnits = 107
CantTargetNeutralUnits = 108
MustTargetEnemyUnits = 109
CantTargetEnemyUnits = 110
MustTargetAirUnits = 111
CantTargetAirUnits = 112
MustTargetGroundUnits = 113
CantTargetGroundUnits = 114
MustTargetStructures = 115
CantTargetStructures = 116
MustTargetLightUnits = 117
CantTargetLightUnits = 118
MustTargetArmoredUnits = 119
CantTargetArmoredUnits = 120
MustTargetBiologicalUnits = 121
CantTargetBiologicalUnits = 122
MustTargetHeroicUnits = 123
CantTargetHeroicUnits = 124
MustTargetRoboticUnits = 125
CantTargetRoboticUnits = 126
MustTargetMechanicalUnits = 127
CantTargetMechanicalUnits = 128
MustTargetPsionicUnits = 129
CantTargetPsionicUnits = 130
MustTargetMassiveUnits = 131
CantTargetMassiveUnits = 132
MustTargetMissile = 133
CantTargetMissile = 134
MustTargetWorkerUnits = 135
CantTargetWorkerUnits = 136
MustTargetEnergyCapableUnits = 137
CantTargetEnergyCapableUnits = 138
MustTargetShieldCapableUnits = 139
CantTargetShieldCapableUnits = 140
MustTargetFlyers = 141
CantTargetFlyers = 142
MustTargetBuriedUnits = 143
CantTargetBuriedUnits = 144
MustTargetCloakedUnits = 145
CantTargetCloakedUnits = 146
MustTargetUnitsInAStasisField = 147
CantTargetUnitsInAStasisField = 148
MustTargetUnderConstructionUnits = 149
CantTargetUnderConstructionUnits = 150
MustTargetDeadUnits = 151
CantTargetDeadUnits = 152
MustTargetRevivableUnits = 153
CantTargetRevivableUnits = 154
MustTargetHiddenUnits = 155
CantTargetHiddenUnits = 156
CantRechargeOtherPlayersUnits = 157
MustTargetHallucinations = 158
CantTargetHallucinations = 159
MustTargetInvulnerableUnits = 160
CantTargetInvulnerableUnits = 161
MustTargetDetectedUnits = 162
CantTargetDetectedUnits = 163
CantTargetUnitWithEnergy = 164
CantTargetUnitWithShields = 165
MustTargetUncommandableUnits = 166
CantTargetUncommandableUnits = 167
MustTargetPreventDefeatUnits = 168
CantTargetPreventDefeatUnits = 169
MustTargetPreventRevealUnits = 170
CantTargetPreventRevealUnits = 171
MustTargetPassiveUnits = 172
CantTargetPassiveUnits = 173
MustTargetStunnedUnits = 174
CantTargetStunnedUnits = 175
MustTargetSummonedUnits = 176
CantTargetSummonedUnits = 177
MustTargetUser1 = 178
CantTargetUser1 = 179
MustTargetUnstoppableUnits = 180
CantTargetUnstoppableUnits = 181
MustTargetResistantUnits = 182
CantTargetResistantUnits = 183
MustTargetDazedUnits = 184
CantTargetDazedUnits = 185
CantLockdown = 186
CantMindControl = 187
MustTargetDestructibles = 188
CantTargetDestructibles = 189
MustTargetItems = 190
CantTargetItems = 191
NoCalldownAvailable = 192
WaypointListFull = 193
MustTargetRace = 194
CantTargetRace = 195
MustTargetSimilarUnits = 196
CantTargetSimilarUnits = 197
CantFindEnoughTargets = 198
AlreadySpawningLarva = 199
CantTargetExhaustedResources = 200
CantUseMinimap = 201
CantUseInfoPanel = 202
OrderQueueIsFull = 203
CantHarvestThatResource = 204
HarvestersNotRequired = 205
AlreadyTargeted = 206
CantAttackWeaponsDisabled = 207
CouldntReachTarget = 208
TargetIsOutOfRange = 209
TargetIsTooClose = 210
TargetIsOutOfArc = 211
CantFindTeleportLocation = 212
InvalidItemClass = 213
CantFindCancelOrder = 214
message
ui.proto:90Used in:
bool selection_add = 1
message
ui.proto:101Used in:
ActionSelectIdleWorker.Type type = 1
Used in:
Type_UNSET = 0
Set = 1
Equivalent to click with no modifiers. Replaces selection with single idle worker.
Add = 2
Equivalent to shift+click. Adds single idle worker to current selection.
All = 3
Equivalent to control+click. Selects all idle workers.
AddAll = 4
Equivalent to shift+control+click. Adds all idle workers to current selection.
message
ui.proto:98Used in:
(message has no fields)
message
ui.proto:94Used in:
bool selection_add = 1
message
spatial.proto:65Used in:
oneof action
unit_command = 1
camera_move = 2
unit_selection_point = 3
unit_selection_rect = 4
message
spatial.proto:84Used in:
optional center_minimap = 1
Simulates a click on the minimap to move the camera.
message
spatial.proto:74Used in:
int32 ability_id = 1
oneof target
target_screen_coord = 2
target_minimap_coord = 3
bool queue_command = 4
Equivalent to shift+command.
message
spatial.proto:88Used in:
optional selection_screen_coord = 1
ActionSpatialUnitSelectionPoint.Type type = 2
Used in:
Type_UNSET = 0
Select = 1
Equivalent to normal click. Changes selection to unit.
Toggle = 2
Equivalent to shift+click. Toggle selection of unit.
AllType = 3
Equivalent to control+click. Selects all units of a given type.
AddAllType = 4
Equivalent to shift+control+click. Selects all units of a given type.
message
spatial.proto:100Used in:
repeated selection_screen_coord = 1
Eventually this should not be an array, but a single field (multiple would be cheating).
bool selection_add = 2
Equivalent to shift+drag. Adds units to selection.
message
ui.proto:132Used in:
int32 ability_id = 1
message
ui.proto:63Used in:
oneof action
control_group = 1
select_army = 2
select_warp_gates = 3
select_larva = 4
select_idle_worker = 5
multi_panel = 6
cargo_panel = 7
production_panel = 8
toggle_autocast = 9
Used in:
Alert_UNSET = 0
NuclearLaunchDetected = 1
NydusWormDetected = 2
enum Alliance
raw.proto:62Used in:
Alliance_UNSET = 0
Self = 1
Ally = 2
Neutral = 3
Enemy = 4
Used in: ,
Attribute_UNSET = 0
Light = 1
Armored = 2
Biological = 3
Mechanical = 4
Robotic = 5
Psionic = 6
Massive = 7
Structure = 8
Hover = 9
Heroic = 10
Summoned = 11
message
common.proto:6Used in: ,
int32 ability_id = 1
bool requires_point = 2
message
data.proto:113Used in:
uint32 buff_id = 1
Stable ID.
string name = 2
message
ui.proto:47Used in:
optional unit = 1
repeated passengers = 2
int32 slots_available = 3
TODO: Change to cargo size
message
score.proto:18Used in:
float none = 1
Used when no other category is configured in game data
float army = 2
float economy = 3
float technology = 4
float upgrade = 5
message
sc2api.proto:348Used in:
uint32 player_id = 1
string message = 2
Used in:
CloakState_UNSET = 0
Cloaked = 1
CloakedDetected = 2
NotCloaked = 3
message
debug.proto:34Used in: , , ,
uint32 r = 1
uint32 g = 2
uint32 b = 3
message
ui.proto:20Used in:
uint32 control_group_index = 1
uint32 leader_unit_type = 2
uint32 count = 3
message
data.proto:55Used in:
Attribute attribute = 1
float bonus = 2
message
debug.proto:56Display debug boxes on screen.
Used in:
optional color = 1
optional min = 2
optional max = 3
message
debug.proto:9Issue various useful commands to the game engine.
Used in:
oneof command
draw = 1
DebugGameState game_state = 2
create_unit = 3
kill_unit = 4
test_process = 5
score = 6
Useful only for single-player "curriculum" maps.
end_game = 7
unit_value = 8
message
debug.proto:85Used in:
uint32 unit_type = 1
int32 owner = 2
optional pos = 3
uint32 quantity = 4
message
debug.proto:22Used in:
repeated text = 1
repeated lines = 2
repeated boxes = 3
repeated spheres = 4
message
debug.proto:111Used in:
DebugEndGame.EndResult end_result = 1
Used in:
EndResult_UNSET = 0
Surrender = 1
Default if nothing is set. The current player admits defeat.
DeclareVictory = 2
Used in:
DebugGameState_UNSET = 0
show_map = 1
control_enemy = 2
food = 3
free = 4
all_resources = 5
god = 6
minerals = 7
gas = 8
cooldown = 9
tech_tree = 10
upgrade = 11
fast_build = 12
message
debug.proto:92Used in:
repeated uint64 tag = 1
message
debug.proto:50Display debug lines on screen.
Used in:
optional color = 1
optional line = 2
World space line.
message
debug.proto:107Used in:
float score = 1
message
debug.proto:120Used in:
DebugSetUnitValue.UnitValue unit_value = 1
float value = 2
uint64 unit_tag = 3
Used in:
UnitValue_UNSET = 0
Energy = 1
Life = 2
Shields = 3
message
debug.proto:63Display debug spheres on screen.
Used in:
optional color = 1
optional p = 2
float r = 3
message
debug.proto:96Used in:
DebugTestProcess.Test test = 1
int32 delay_ms = 2
Used in:
Test_UNSET = 0
hang = 1
crash = 2
exit = 3
message
debug.proto:41Display debug text on screen.
Used in:
optional color = 1
string text = 2
Text to display.
optional virtual_pos = 3
Virtualized position in 2D (the screen is 0..1, 0..1 for any resolution).
optional world_pos = 4
Position in the world.
uint32 size = 5
Pixel height of the text. Defaults to 8px.
Used in: ,
Difficulty_UNSET = 0
VeryEasy = 1
Easy = 2
Medium = 3
MediumHard = 4
Hard = 5
Harder = 6
VeryHard = 7
CheatVision = 8
CheatMoney = 9
CheatInsane = 10
Used in:
DisplayType_UNSET = 0
Visible = 1
Fully visible
Snapshot = 2
Dimmed version of unit left behind after entering fog of war
Hidden = 3
Fully hidden
message
raw.proto:145Used in:
uint32 effect_id = 1
repeated pos = 2
Effect may impact multiple locations. (eg. Lurker attack)
message
data.proto:118Used in:
uint32 effect_id = 1
Stable ID.
string name = 2
string friendly_name = 3
float radius = 4
message
raw.proto:141Used in:
repeated uint64 dead_units = 1
message
spatial.proto:17Used in:
optional height_map = 1
uint8. Terrain height. World space units of [-200, 200] encoded into [0, 255].
optional visibility_map = 2
uint8. 0=Hidden, 1=Fogged, 2=Visible, 3=FullHidden
optional creep = 3
1-bit. Zerg creep.
optional power = 4
1-bit. Protoss power.
optional player_id = 5
uint8. Participants: [1, 15] Neutral: 16
optional unit_type = 6
int32. Unique identifier for type of unit.
optional selected = 7
1-bit. Selected units.
optional unit_hit_points = 8
int32.
optional unit_hit_points_ratio = 17
uint8. Ratio of current health to max health. [0%, 100%] encoded into [0, 255].
optional unit_energy = 9
int32.
optional unit_energy_ratio = 18
uint8. Ratio of current energy to max energy. [0%, 100%] encoded into [0, 255].
optional unit_shields = 10
int32.
optional unit_shields_ratio = 19
uint8. Ratio of current shields to max shields. [0%, 100%] encoded into [0, 255].
optional player_relative = 11
uint8. See "Alliance" enum in raw.proto. Range: [1, 4]
optional unit_density_aa = 14
uint8. Density of units overlapping a pixel, anti-aliased. [0.0, 16.0f] encoded into [0, 255].
optional unit_density = 15
uint8. Count of units overlapping a pixel.
optional effects = 20
uint8. Visuals of persistent abilities. (eg. Psistorm)
message
spatial.proto:37Used in:
optional height_map = 1
uint8. Terrain height. World space units of [-200, 200] encoded into [0, 255].
optional visibility_map = 2
uint8. 0=Hidden, 1=Fogged, 2=Visible, 3=FullHidden
optional creep = 3
1-bit. Zerg creep.
optional camera = 4
1-bit. Area covered by the camera.
optional player_id = 5
uint8. Participants: [1, 15] Neutral: 16
optional player_relative = 6
uint8. See "Alliance" enum in raw.proto. Range: [1, 4]
optional selected = 7
1-bit. Selected units.
optional unit_type = 8
Cheat layers. Only populated in replays.
int32. Unique identifier for type of unit.
message
common.proto:11Used in: , , , ,
int32 bits_per_pixel = 1
Number of bits per pixel; 8 bits for a byte etc.
optional size = 2
Dimension in pixels.
bytes data = 3
Binary data; the size of this buffer in bytes is width * height * bits_per_pixel / 8.
message
sc2api.proto:529Used in: , ,
bool raw = 1
Interface options
bool score = 2
optional feature_layer = 3
Omit to disable.
optional render = 4
Not implemented.
message
debug.proto:29Used in:
optional p0 = 1
optional p1 = 2
message
sc2api.proto:180Used in:
string map_path = 1
A map can be specified either by a file path or the data of the .SC2Map file. If you provide both, it will play the game using map_data and store map_path into the replay. (260 character max)
bytes map_data = 7
message
raw.proto:136Used in:
optional visibility = 1
1 byte visibility layer.
optional creep = 2
1 byte creep layer.
message
ui.proto:43Used in:
repeated units = 1
message
sc2api.proto:566Used in:
uint32 game_loop = 9
optional player_common = 1
repeated Alert alerts = 10
repeated abilities = 3
Abilities available in the selection. Enabled if in this list, disabled otherwise.
optional score = 4
optional raw_data = 5
Populated if Raw interface is enabled.
optional feature_layer_data = 6
Populated if Feature Layer interface is enabled.
optional render_data = 7
Populated if Render interface is enabled.
optional ui_data = 8
Populated if Feature Layer or Render interface is enabled.
message
spatial.proto:12Used in:
optional renders = 1
optional minimap_renders = 2
message
raw.proto:26Used in:
optional player = 1
repeated units = 2
optional map_state = 3
Fog of war, creep and so on. Board stuff that changes per frame.
optional event = 4
repeated effects = 5
message
spatial.proto:55Used in:
optional map = 1
optional minimap = 2
message
ui.proto:10Used in:
repeated groups = 1
oneof panel
single = 2
multi = 3
cargo = 4
production = 5
message
sc2api.proto:603Used in:
oneof action
player_perspective = 1
Not implemented
camera_move = 2
camera_follow_player = 3
camera_follow_units = 4
Not implemented
message
raw.proto:77Used in:
uint64 tag = 1
float health = 2
float health_max = 3
float shield = 4
float shield_max = 7
float energy = 5
float energy_max = 8
uint32 unit_type = 6
message
sc2api.proto:552Used in:
uint32 player_id = 1
uint32 minerals = 2
uint32 vespene = 3
uint32 food_cap = 4
uint32 food_used = 5
uint32 food_army = 6
uint32 food_workers = 7
uint32 idle_worker_count = 8
uint32 army_count = 9
uint32 warp_gate_count = 10
uint32 larva_count = 11
message
sc2api.proto:537Used in: ,
uint32 player_id = 1
Identifier that will be used to reference this player. SC2 will always assign playerIds starting from 1 in standard Melee maps. This may not be true in custom maps.
PlayerType type = 2
Race race_requested = 3
Race race_actual = 4
Only populated for your player or when watching replay
Difficulty difficulty = 5
message
sc2api.proto:413Used in:
optional player_info = 1
optional player_result = 2
int32 player_mmr = 3
int32 player_apm = 4
message
raw.proto:40Used in:
repeated power_sources = 1
optional camera = 2
repeated uint32 upgrade_ids = 3
TODO: Add to UI observation?
message
sc2api.proto:646Used in: ,
uint32 player_id = 1
Result result = 2
message
sc2api.proto:515Used in:
PlayerType type = 1
Race race = 2
Only used for a computer player.
Difficulty difficulty = 3
Used in: ,
PlayerType_UNSET = 0
Participant = 1
Computer = 2
Observer = 3
message
common.proto:39Point on the game board, 0..255. Note: bottom left of the screen is 0, 0.
Used in: , , , , , , , ,
float x = 1
float y = 2
float z = 3
message
common.proto:32Point on the game board, 0..255. Note: bottom left of the screen is 0, 0.
Used in: , , , , , ,
float x = 1
float y = 2
message
common.proto:19Point on the screen/minimap (e.g., 0..64). Note: bottom left of the screen is 0, 0.
Used in: , , ,
int32 x = 1
int32 y = 2
message
sc2api.proto:220Used in:
int32 game_port = 1
Game right now needs two internal ports to establish a multiplay game on the local host.
int32 base_port = 2
message
raw.proto:34Used in:
optional pos = 1
float radius = 2
uint64 tag = 3
message
ui.proto:53Used in:
optional unit = 1
repeated build_queue = 2
enum Race
common.proto:51Used in: , , ,
NoRace = 0
Terran = 1
Zerg = 2
Protoss = 3
Random = 4
message
common.proto:25Screen space rectangular area.
Used in: ,
optional p0 = 1
optional p1 = 2
message
sc2api.proto:83oneof request
create_game = 1
Game Setup
Send to host to initialize game.
join_game = 2
Send to host and all clients for game to begin.
restart_game = 3
Single player only. Reinitializes the game with the same player setup.
start_replay = 4
Start playing a replay.
leave_game = 5
Multiplayer only. Disconnects from a multiplayer game, equivalent to surrender.
quick_save = 6
Saves game to an in-memory bookmark.
quick_load = 7
Loads from an in-memory bookmark.
quit = 8
Terminates the application.
game_info = 9
During Game
Static data about the current game and map.
observation = 10
Snapshot of the current game state.
action = 11
Executes an action for a participant.
obs_action = 21
Executes an action for an observer.
step = 12
Advances the game simulation.
data = 13
Data about different gameplay elements. May be different for different games.
query = 14
Additional methods for inspecting game state.
save_replay = 15
Generates a replay.
replay_info = 16
Other.
Returns metadata about a replay file. Does not load the replay.
available_maps = 17
Returns directory of maps that can be played on.
save_map = 18
Saves binary map data to the local temp directory.
ping = 19
Debugging
Network ping for testing connection.
debug = 20
Display debug information and execute debug actions.
message
sc2api.proto:354-----------------------------------------------------------------------------
Used in:
repeated actions = 1
message
sc2api.proto:444-----------------------------------------------------------------------------
Used in:
(message has no fields)
message
sc2api.proto:166----------------------------------------------------------------------------- If successful, puts the game into the status: init_game. The next expected request should be RequestJoinGame. Can also quit (exit).
Used in:
oneof Map
local_map = 1
Local .SC2Map file
string battlenet_map_name = 2
Map published to BattleNet
repeated player_setup = 3
bool disable_fog = 4
uint32 random_seed = 5
Sets the pseudo-random seed for the game.
bool realtime = 6
If set, the game plays in real time.
message
sc2api.proto:380-----------------------------------------------------------------------------
Used in:
bool ability_id = 1
bool unit_type_id = 2
bool upgrade_id = 3
bool buff_id = 4
bool effect_id = 5
message
sc2api.proto:482-----------------------------------------------------------------------------
Used in:
repeated debug = 1
message
sc2api.proto:323-----------------------------------------------------------------------------
Used in:
(message has no fields)
message
sc2api.proto:207----------------------------------------------------------------------------- If successful, puts the game into the status: in_game. Will be able to request actions, observations and step the game.
Used in:
oneof participation
Race race = 1
Join as participant
uint32 observed_player_id = 2
Join as observer
optional options = 3
This is limited to what is specified in RequestCreateGame, but you can request less information if you want.
optional server_ports = 4
Do not set in the single-player case. This is the port a server will use.
repeated client_ports = 5
Do not set in the single-player case. These are the ports clients will use to initialize communication.
int32 shared_port = 6
Currently only a singe client is supported.
message
sc2api.proto:293-----------------------------------------------------------------------------
Used in:
(message has no fields)
message
sc2api.proto:336-----------------------------------------------------------------------------
Used in:
bool disable_fog = 1
message
sc2api.proto:363-----------------------------------------------------------------------------
Used in:
repeated actions = 1
message
sc2api.proto:471-----------------------------------------------------------------------------
Used in:
(message has no fields)
message
query.proto:9Used in:
repeated pathing = 1
repeated abilities = 2
repeated placements = 3
bool ignore_resource_requirements = 4
Ignores requirements like food, minerals and so on.
message
query.proto:36--------------------------------------------------------------------------------------------------
Used in:
uint64 unit_tag = 1
message
query.proto:47--------------------------------------------------------------------------------------------------
Used in:
int32 ability_id = 1
optional target_pos = 2
uint64 placing_unit_tag = 3
Not required
message
query.proto:23--------------------------------------------------------------------------------------------------
Used in:
oneof start
start_pos = 1
uint64 unit_tag = 2
optional end_pos = 3
message
sc2api.proto:308-----------------------------------------------------------------------------
Used in:
(message has no fields)
message
sc2api.proto:300-----------------------------------------------------------------------------
Used in:
(message has no fields)
message
sc2api.proto:316-----------------------------------------------------------------------------
Used in:
(message has no fields)
message
sc2api.proto:405-----------------------------------------------------------------------------
Used in:
oneof replay
string replay_path = 1
Limitation: might fail if the replay file is currently loaded.
bytes replay_data = 2
bool download_data = 3
Ensure the data and binary are downloaded if this is an old version replay.
message
sc2api.proto:251-----------------------------------------------------------------------------
Used in:
(message has no fields)
message
sc2api.proto:457----------------------------------------------------------------------------- Copies map data into the path specified.
Used in:
string map_path = 1
Path the game process will write to, relative to the temp directory. (260 character max)
bytes map_data = 2
Binary map data of a .SC2Map.
message
sc2api.proto:397-----------------------------------------------------------------------------
Used in:
(message has no fields)
message
sc2api.proto:264-----------------------------------------------------------------------------
Used in:
oneof replay
string replay_path = 1
bytes replay_data = 5
bytes map_data = 6
Overrides the map path stored in the replay.
int32 observed_player_id = 2
optional options = 3
bool disable_fog = 4
bool realtime = 7
message
sc2api.proto:372-----------------------------------------------------------------------------
Used in:
uint32 count = 1
Number of game loops to simulate for the next frame.
message
sc2api.proto:118oneof response
create_game = 1
join_game = 2
restart_game = 3
start_replay = 4
leave_game = 5
quick_save = 6
quick_load = 7
quit = 8
game_info = 9
observation = 10
action = 11
obs_action = 21
step = 12
data = 13
query = 14
save_replay = 15
replay_info = 16
available_maps = 17
save_map = 18
ping = 19
Debugging
debug = 20
repeated string error = 98
If command is missing, this will contain the error. Otherwise this will contain any warnings.
Status status = 99
Should be sent back with all responses.
message
sc2api.proto:358Used in:
repeated ActionResult result = 1
message
sc2api.proto:450This will only contain locally cached BattleNet maps. To download all ladder maps, log in and queue into a ladder match. To download any other map, play a custom game on that map.
Used in:
repeated string local_map_paths = 1
All the maps in the "Maps/" directory.
repeated string battlenet_map_names = 2
All the maps in the BattleNet cache.
message
sc2api.proto:188Used in:
ResponseCreateGame.Error error = 1
string error_details = 2
Used in:
Error_UNSET = 0
MissingMap = 1
InvalidMapPath = 2
InvalidMapData = 3
InvalidMapName = 4
InvalidMapHandle = 5
MissingPlayerSetup = 6
InvalidPlayerSetup = 7
MultiplayerUnsupported = 8
Multiplayer is not supported in the current build.
message
sc2api.proto:388Used in:
repeated abilities = 1
repeated units = 2
repeated upgrades = 3
repeated buffs = 4
repeated effects = 5
message
sc2api.proto:486Used in:
(message has no fields)
message
sc2api.proto:326Used in:
string map_name = 1
repeated string mod_names = 6
string local_map_path = 2
repeated player_info = 3
optional start_raw = 4
Populated if Raw interface is enabled.
optional options = 5
message
sc2api.proto:225Used in:
uint32 player_id = 1
ResponseJoinGame.Error error = 2
string error_details = 3
Used in:
Error_UNSET = 0
MissingParticipation = 1
InvalidObservedPlayerId = 2
MissingOptions = 3
MissingPorts = 4
GameFull = 5
LaunchError = 6
FeatureUnsupported = 7
Multiplayer specific.
Multiplayer is not supported in the current build for the requested features.
NoSpaceForUser = 8
MapDoesNotExist = 9
CannotOpenMap = 10
ChecksumError = 11
NetworkError = 12
OtherError = 13
message
sc2api.proto:296Used in:
(message has no fields)
message
sc2api.proto:340Used in:
repeated actions = 1
Actions this player did since the last Observation.
repeated action_errors = 2
Equivalent of UI "red text" errors.
optional observation = 3
repeated player_result = 4
Only populated if the game ended during this step.
repeated chat = 5
message
sc2api.proto:367Used in:
(message has no fields)
message
sc2api.proto:474Used in:
string game_version = 1
string data_version = 2
uint32 data_build = 3
uint32 base_build = 4
message
query.proto:16Used in:
repeated pathing = 1
repeated abilities = 2
repeated placements = 3
message
query.proto:40Used in:
repeated abilities = 1
uint64 unit_tag = 2
uint32 unit_type_id = 3
message
query.proto:53Used in:
ActionResult result = 1
message
query.proto:31Used in:
float distance = 1
0 if no path exists
message
sc2api.proto:312-----------------------------------------------------------------------------
Used in:
(message has no fields)
message
sc2api.proto:304-----------------------------------------------------------------------------
Used in:
(message has no fields)
message
sc2api.proto:319Used in:
(message has no fields)
message
sc2api.proto:420Used in:
string map_name = 1
string local_map_path = 2
repeated player_info = 3
uint32 game_duration_loops = 4
float game_duration_seconds = 5
string game_version = 6
string data_version = 11
uint32 data_build = 7
uint32 base_build = 8
ResponseReplayInfo.Error error = 9
string error_details = 10
Used in:
Error_UNSET = 0
MissingReplay = 1
InvalidReplayPath = 2
InvalidReplayData = 3
ParsingError = 4
DownloadError = 5
message
sc2api.proto:254Used in:
ResponseRestartGame.Error error = 1
string error_details = 2
Used in:
Error_UNSET = 0
LaunchError = 1
message
sc2api.proto:462Used in:
ResponseSaveMap.Error error = 1
Used in:
Error_UNSET = 0
InvalidMapData = 1
message
sc2api.proto:400Used in:
bytes data = 1
message
sc2api.proto:277Used in:
ResponseStartReplay.Error error = 1
string error_details = 2
Used in:
Error_UNSET = 0
MissingReplay = 1
InvalidReplayPath = 2
InvalidReplayData = 3
InvalidMapData = 4
InvalidObservedPlayerId = 5
MissingOptions = 6
LaunchError = 7
message
sc2api.proto:376Used in:
(message has no fields)
Used in:
Result_UNSET = 0
Victory = 1
Defeat = 2
Tie = 3
Undecided = 4
message
score.proto:6Used in:
Score.ScoreType score_type = 6
int32 score = 7
Note: check score_type to know whether this is a melee score or curriculum score
optional score_details = 8
Used in:
ScoreType_UNSET = 0
Curriculum = 1
map generated score (from curriculum maps with special scoring)
Melee = 2
summation of in-progress and current units/buildings value + minerals + vespene
message
score.proto:32Used in:
float idle_production_time = 1
Sum of time any available structure able to produce a unit is not. The time stacks, as in, three idle barracks will increase idle_production_time three times quicker than just one.
float idle_worker_time = 2
Sum of time any worker is not mining. Note a worker building is not idle and three idle workers will increase this value three times quicker than just one.
float total_value_units = 3
Sum of minerals and vespene spent on completed units.
float total_value_structures = 4
Sum of minerals and vespene spent on completed structures.
float killed_value_units = 5
Sum of minerals and vespene of units, belonging to the opponent, that the player has destroyed.
float killed_value_structures = 6
Sum of minerals and vespene of structures, belonging to the opponent, that the player has destroyed.
float collected_minerals = 7
Sum of minerals collected by the player.
float collected_vespene = 8
Sum of vespene collected by the player.
float collection_rate_minerals = 9
Estimated income of minerals over the next minute based on the players current income. The unit is minerals per minute.
float collection_rate_vespene = 10
Estimated income of vespene over the next minute based on the players current income. The unit is vespene per minute.
float spent_minerals = 11
Sum of spent minerals at the moment it is spent. For example, this number is incremented by 50 the moment an scv is queued in a command center. It is decremented by 50 if that unit is canceled.
float spent_vespene = 12
Sum of spent vespene at the moment it is spent. For example, this number is incremented by 50 when a reaper is queued but decremented by 50 if it is canceled.
optional food_used = 13
Sum of food, or supply, utilized in the categories above.
optional killed_minerals = 14
Sum of enemies catagories destroyed in minerals.
optional killed_vespene = 15
Sum of enemies catagories destroyed in vespene.
optional lost_minerals = 16
Sum of lost minerals for the player in each category.
optional lost_vespene = 17
Sum of lost vespene for the player in each category.
optional friendly_fire_minerals = 18
Sum of the lost minerals via destroying the players own units/buildings.
optional friendly_fire_vespene = 19
Sum of the lost vespene via destroying the players own units/buildings.
optional used_minerals = 20
Sum of used minerals for the player in each category for each existing unit or upgrade. Therefore if a unit died worth 50 mierals this number will be decremented by 50.
optional used_vespene = 21
Sum of used vespene for the player in each category. Therefore if a unit died worth 50 vespene this number will be decremented by 50.
optional total_used_minerals = 22
Sum of used minerals throughout the entire game for each category. Unliked used_minerals, this value is never decremented.
optional total_used_vespene = 23
Sum of used vespene throughout the entire game for each category. Unliked used_vespene, this value is never decremented.
optional total_damage_dealt = 24
Sum of damage dealt to the player's opponent for each category.
optional total_damage_taken = 25
Sum of damage taken by the player for each category.
optional total_healed = 26
Sum of health healed by the player. Note that technology can be healed (by queens) or repaired (by scvs).
message
ui.proto:37Used in:
optional unit = 1
Upgrades? Buffs?
message
common.proto:46Screen dimensions.
Used in: , ,
int32 x = 1
int32 y = 2
message
sc2api.proto:523Used in:
float width = 1
optional resolution = 2
optional minimap_resolution = 3
message
raw.proto:12Used in:
optional map_size = 1
Width and height of the map.
optional pathing_grid = 2
1 byte bitmap of the pathing grid.
optional terrain_height = 3
1 byte bitmap of the terrain height.
optional placement_grid = 4
1 byte bitmap of the building placement grid.
optional playable_area = 5
The playable cells.
repeated start_locations = 6
Possible start locations for players.
Used in:
Status_UNSET = 0
launched = 1
Game has been launch and is not yet doing anything.
init_game = 2
Create game has been called, and the host is awaiting players.
in_game = 3
In a single or multiplayer game.
in_replay = 4
In a replay.
ended = 5
Game has ended, can still request game info, but ready for a new game.
quit = 6
Application is shutting down.
unknown = 99
Should not happen, but indicates an error if it occurs.
message
raw.proto:88Used in:
DisplayType display_type = 1
Fields are populated based on type/alliance
Alliance alliance = 2
uint64 tag = 3
Unique identifier for a unit
uint32 unit_type = 4
int32 owner = 5
optional pos = 6
float facing = 7
float radius = 8
float build_progress = 9
Range: [0.0, 1.0]
CloakState cloak = 10
float detect_range = 31
float radar_range = 32
bool is_selected = 11
bool is_on_screen = 12
Visible and within the camera frustrum.
bool is_blip = 13
Detected by sensor tower
bool is_powered = 35
float health = 14
Not populated for snapshots
float health_max = 15
float shield = 16
float shield_max = 36
float energy = 17
float energy_max = 37
int32 mineral_contents = 18
int32 vespene_contents = 19
bool is_flying = 20
bool is_burrowed = 21
repeated orders = 22
Not populated for enemies
uint64 add_on_tag = 23
repeated passengers = 24
int32 cargo_space_taken = 25
int32 cargo_space_max = 26
repeated uint32 buff_ids = 27
TODO: Should this be populated for enemies?
int32 assigned_harvesters = 28
int32 ideal_harvesters = 29
float weapon_cooldown = 30
uint64 engaged_target_tag = 34
message
ui.proto:26Used in: , , ,
uint32 unit_type = 1
uint32 player_relative = 2
int32 health = 3
int32 shields = 4
int32 energy = 5
int32 transport_slots_taken = 6
float build_progress = 7
Range: [0.0, 1.0]
optional add_on = 8
message
raw.proto:46Used in:
uint32 ability_id = 1
oneof target
target_world_space_pos = 2
uint64 target_unit_tag = 3
float progress = 4
Progress of train abilities. Range: [0.0, 1.0]
message
data.proto:75Used in:
uint32 unit_id = 1
Stable ID.
string name = 2
Catalog name of the unit.
bool available = 3
If true, the ability may be used by this set of mods/map.
uint32 cargo_size = 4
Number of cargo slots it occupies in transports.
uint32 mineral_cost = 12
uint32 vespene_cost = 13
float food_required = 14
float food_provided = 18
uint32 ability_id = 15
The ability that builds this unit.
Race race = 16
float build_time = 17
bool has_vespene = 19
bool has_minerals = 20
float sight_range = 25
Range unit reveals vision.
repeated uint32 tech_alias = 21
Other units that satisfy the same tech requirement.
uint32 unit_alias = 22
The morphed variant of this unit.
uint32 tech_requirement = 23
Structure required to build this unit. (Or any with the same tech_alias)
bool require_attached = 24
Whether tech_requirement is an add-on.
repeated Attribute attributes = 8
Values include changes from upgrades
float movement_speed = 9
float armor = 10
repeated weapons = 11
message
data.proto:104Used in:
uint32 upgrade_id = 1
Stable ID.
string name = 2
uint32 mineral_cost = 3
uint32 vespene_cost = 4
float research_time = 5
uint32 ability_id = 6
message
score.proto:26Used in:
float life = 1
float shields = 2
float energy = 3
message
data.proto:60Used in:
Weapon.TargetType type = 1
float damage = 2
repeated damage_bonus = 3
uint32 attacks = 4
Number of hits per attack. (eg. Colossus has 2 beams)
float range = 5
float speed = 6
Time between attacks.
Used in:
TargetType_UNSET = 0
Ground = 1
Air = 2
Any = 3