package SC2APIProtocol

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: PlayerInfo, PlayerSetup

• RandomBuild = 1

• Rush = 2

• Timing = 3

• Power = 4

• Macro = 5

• Air = 6

May 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: ResponseData

• optional uint32 ability_id = 1

  Stable ID.

• optional string link_name = 2

  Catalog name of the ability.

• optional uint32 link_index = 3

  Catalog index of the ability.

• optional string button_name = 4

  Name used for the command card. May not always be set.

• optional string friendly_name = 5

  A human friendly name when the button name or link name isn't descriptive.

• optional string hotkey = 6

  Hotkey. May not always be set.

• optional uint32 remaps_to_ability_id = 7

  This ability id may be represented by the given more generic id.

• optional bool available = 8

  If true, the ability may be used by this set of mods/map.

• optional AbilityData.Target target = 9

  Determines if a point is optional or required.

• optional bool allow_minimap = 10

  Can be cast in the minimap.

• optional bool allow_autocast = 11

  Autocast can be set.

• optional bool is_building = 12

  Requires placement to construct a building.

• optional float footprint_radius = 13

  Estimation of the footprint size. Need a better footprint.

• optional bool is_instant_placement = 14

  Placement next to an existing structure, e.g., an add-on like a Tech Lab.

• optional float cast_range = 15

  Range unit can cast ability without needing to approach target.

Used in: AbilityData

• 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)

Used in: RequestAction, ResponseObservation

• optional ActionRaw action_raw = 1

  Populated if Raw interface is enabled.

• optional ActionSpatial action_feature_layer = 2

  Populated if Feature Layer interface is enabled.

• optional ActionSpatial action_render = 3

  Not implemented. Populated if Render interface is enabled.

• optional ActionUI action_ui = 4

  Populated if Feature Layer or Render interface is enabled.

• optional ActionChat action_chat = 6

  Chat messages as a player typing into the chat channel.

• optional uint32 game_loop = 7

  Populated for actions in ResponseObservation. The game loop on which the action was executed.

Used in: ActionUI

• optional int32 unit_index = 1

Used in: Action

• optional ActionChat.Channel channel = 1

• optional string message = 2

Used in: ActionChat

• Broadcast = 1

• Team = 2

Used in: ActionUI

• optional ActionControlGroup.ControlGroupAction action = 1

• optional uint32 control_group_index = 2

Used in: ActionControlGroup

• 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.

Used in: ResponseObservation

• optional uint64 unit_tag = 1

  Only populated when using raw interface.

• optional uint64 ability_id = 2

• optional ActionResult result = 3

Used in: ActionUI

• optional ActionMultiPanel.Type type = 1

• optional int32 unit_index = 2

Used in: ActionMultiPanel

• SingleSelect = 1

  Click on icon

• DeselectUnit = 2

  Shift Click on icon

• SelectAllOfType = 3

  Control Click on icon.

• DeselectAllOfType = 4

  Control+Shift Click on icon.

Used in: ObserverAction

• optional uint32 player_id = 1

  Not implemented. Value must be [1, 15]

Used in: ObserverAction

• repeated uint64 unit_tags = 1

Used in: ObserverAction

• optional Point2D world_pos = 1

• optional float distance = 2

  Distance between camera and terrain. Larger value zooms out camera. Defaults to standard camera distance if set to 0.

Used in: ObserverAction

• optional uint32 player_id = 1

  0 to observe "Everyone"

Used in: ActionUI

• optional int32 unit_index = 1

Used in: Action

• oneof action

  • ActionRawUnitCommand unit_command = 1

  • ActionRawCameraMove camera_move = 2

  • ActionRawToggleAutocast toggle_autocast = 3

Used in: ActionRaw

• optional Point center_world_space = 1

Used in: ActionRaw

• optional int32 ability_id = 1

• repeated uint64 unit_tags = 2

Used in: ActionRaw

• optional int32 ability_id = 1

• oneof target

  • Point2D target_world_space_pos = 2

  • uint64 target_unit_tag = 3

• repeated uint64 unit_tags = 4

• optional bool queue_command = 5

Used in: ActionError, ResponseAction, ResponseQueryBuildingPlacement

• 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

Used in: ActionUI

• optional bool selection_add = 1

Used in: ActionUI

• optional ActionSelectIdleWorker.Type type = 1

Used in: ActionSelectIdleWorker

• 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.

Used in: ActionUI

(message has no fields)

Used in: ActionUI

• optional bool selection_add = 1

Used in: Action

• oneof action

  • ActionSpatialUnitCommand unit_command = 1

  • ActionSpatialCameraMove camera_move = 2

  • ActionSpatialUnitSelectionPoint unit_selection_point = 3

  • ActionSpatialUnitSelectionRect unit_selection_rect = 4

Used in: ActionSpatial

• optional PointI center_minimap = 1

  Simulates a click on the minimap to move the camera.

Used in: ActionSpatial

• optional int32 ability_id = 1

• oneof target

  • PointI target_screen_coord = 2

  • PointI target_minimap_coord = 3

• optional bool queue_command = 4

  Equivalent to shift+command.

Used in: ActionSpatial

• optional PointI selection_screen_coord = 1

• optional ActionSpatialUnitSelectionPoint.Type type = 2

Used in: ActionSpatialUnitSelectionPoint

• 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.

Used in: ActionSpatial

• repeated RectangleI selection_screen_coord = 1

  Eventually this should not be an array, but a single field (multiple would be cheating).

• optional bool selection_add = 2

  Equivalent to shift+drag. Adds units to selection.

Used in: ActionUI

• optional int32 ability_id = 1

Used in: Action

• oneof action

  • ActionControlGroup control_group = 1

  • ActionSelectArmy select_army = 2

  • ActionSelectWarpGates select_warp_gates = 3

  • ActionSelectLarva select_larva = 4

  • ActionSelectIdleWorker select_idle_worker = 5

  • ActionMultiPanel multi_panel = 6

  • ActionCargoPanelUnload cargo_panel = 7

  • ActionProductionPanelRemoveFromQueue production_panel = 8

  • ActionToggleAutocast toggle_autocast = 9

Used in: Observation

• AlertError = 3

• AddOnComplete = 4

• BuildingComplete = 5

• BuildingUnderAttack = 6

• LarvaHatched = 7

• MergeComplete = 8

• MineralsExhausted = 9

• MorphComplete = 10

• MothershipComplete = 11

• MULEExpired = 12

• NuclearLaunchDetected = 1

• NukeComplete = 13

• NydusWormDetected = 2

• ResearchComplete = 14

• TrainError = 15

• TrainUnitComplete = 16

• TrainWorkerComplete = 17

• TransformationComplete = 18

• UnitUnderAttack = 19

• UpgradeComplete = 20

• VespeneExhausted = 21

• WarpInComplete = 22

Used in: Effect, Unit

• Self = 1

• Ally = 2

• Neutral = 3

• Enemy = 4

Used in: DamageBonus, UnitTypeData

• Light = 1

• Armored = 2

• Biological = 3

• Mechanical = 4

• Robotic = 5

• Psionic = 6

• Massive = 7

• Structure = 8

• Hover = 9

• Heroic = 10

• Summoned = 11

Used in: Observation, ResponseQueryAvailableAbilities

• optional int32 ability_id = 1

• optional bool requires_point = 2

Used in: ResponseData

• optional uint32 buff_id = 1

  Stable ID.

• optional string name = 2

Used in: ProductionPanel

• optional uint32 ability_id = 1

• optional float build_progress = 2

  Range: [0.0, 1.0]

Used in: ObservationUI

• optional UnitInfo unit = 1

• repeated UnitInfo passengers = 2

• optional int32 slots_available = 3

  TODO: Change to cargo size

Used in: ScoreDetails

• optional float none = 1

  Used when no other category is configured in game data

• optional float army = 2

• optional float economy = 3

• optional float technology = 4

• optional float upgrade = 5

Used in: ResponseObservation

• optional uint32 player_id = 1

• optional string message = 2

Used in: Unit

• CloakedUnknown = 0

  Under the fog, so unknown whether it's cloaked or not.

• Cloaked = 1

• CloakedDetected = 2

• NotCloaked = 3

• CloakedAllied = 4

Used in: DebugBox, DebugLine, DebugSphere, DebugText

• optional uint32 r = 1

• optional uint32 g = 2

• optional uint32 b = 3

Used in: ObservationUI

• optional uint32 control_group_index = 1

• optional uint32 leader_unit_type = 2

• optional uint32 count = 3

Used in: Weapon

• optional Attribute attribute = 1

• optional float bonus = 2

Display debug boxes on screen.

Used in: DebugDraw

• optional Color color = 1

• optional Point min = 2

• optional Point max = 3

Issue various useful commands to the game engine.

Used in: RequestDebug

• oneof command

  • DebugDraw draw = 1

  • DebugGameState game_state = 2

  • DebugCreateUnit create_unit = 3

  • DebugKillUnit kill_unit = 4

  • DebugTestProcess test_process = 5

  • DebugSetScore score = 6

    Useful only for single-player "curriculum" maps.

  • DebugEndGame end_game = 7

  • DebugSetUnitValue unit_value = 8

Used in: DebugCommand

• optional uint32 unit_type = 1

• optional int32 owner = 2

• optional Point2D pos = 3

• optional uint32 quantity = 4

Used in: DebugCommand

• repeated DebugText text = 1

• repeated DebugLine lines = 2

• repeated DebugBox boxes = 3

• repeated DebugSphere spheres = 4

Used in: DebugCommand

• optional DebugEndGame.EndResult end_result = 1

Used in: DebugEndGame

• Surrender = 1

  Default if nothing is set. The current player admits defeat.

• DeclareVictory = 2

Used in: DebugCommand

• 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

Used in: DebugCommand

• repeated uint64 tag = 1

Display debug lines on screen.

Used in: DebugDraw

• optional Color color = 1

• optional Line line = 2

  World space line.

Used in: DebugCommand

• optional float score = 1

Used in: DebugCommand

• optional DebugSetUnitValue.UnitValue unit_value = 1

• optional float value = 2

• optional uint64 unit_tag = 3

Used in: DebugSetUnitValue

• Energy = 1

• Life = 2

• Shields = 3

Display debug spheres on screen.

Used in: DebugDraw

• optional Color color = 1

• optional Point p = 2

• optional float r = 3

Used in: DebugCommand

• optional DebugTestProcess.Test test = 1

• optional int32 delay_ms = 2

Used in: DebugTestProcess

• hang = 1

• crash = 2

• exit = 3

Display debug text on screen.

Used in: DebugDraw

• optional Color color = 1

• optional string text = 2

  Text to display.

• optional Point virtual_pos = 3

  Virtualized position in 2D (the screen is 0..1, 0..1 for any resolution).

• optional Point world_pos = 4

  Position in the world.

• optional uint32 size = 5

  Pixel height of the text. Defaults to 8px.

Used in: PlayerInfo, PlayerSetup

• VeryEasy = 1

• Easy = 2

• Medium = 3

• MediumHard = 4

• Hard = 5

• Harder = 6

• VeryHard = 7

• CheatVision = 8

• CheatMoney = 9

• CheatInsane = 10

Used in: Unit

• Visible = 1

  Fully visible

• Snapshot = 2

  Dimmed version of unit left behind after entering fog of war

• Hidden = 3

  Fully hidden

• Placeholder = 4

  Building that hasn't started construction.

Used in: ObservationRaw

• optional uint32 effect_id = 1

• repeated Point2D pos = 2

  Effect may impact multiple locations. (eg. Lurker attack)

• optional Alliance alliance = 3

• optional int32 owner = 4

• optional float radius = 5

Used in: ResponseData

• optional uint32 effect_id = 1

  Stable ID.

• optional string name = 2

• optional string friendly_name = 3

• optional float radius = 4

Used in: ObservationRaw

• repeated uint64 dead_units = 1

Used in: ObservationFeatureLayer

• optional ImageData height_map = 1

  uint8. Terrain height. World space units of [-200, 200] encoded into [0, 255].

• optional ImageData visibility_map = 2

  uint8. 0=Hidden, 1=Fogged, 2=Visible, 3=FullHidden

• optional ImageData creep = 3

  1-bit. Zerg creep.

• optional ImageData power = 4

  1-bit. Protoss power.

• optional ImageData player_id = 5

  uint8. Participants: [1, 15] Neutral: 16

• optional ImageData unit_type = 6

  int32. Unique identifier for type of unit.

• optional ImageData selected = 7

  1-bit. Selected units.

• optional ImageData unit_hit_points = 8

  int32.

• optional ImageData unit_hit_points_ratio = 17

  uint8. Ratio of current health to max health. [0%, 100%] encoded into [0, 255].

• optional ImageData unit_energy = 9

  int32.

• optional ImageData unit_energy_ratio = 18

  uint8. Ratio of current energy to max energy. [0%, 100%] encoded into [0, 255].

• optional ImageData unit_shields = 10

  int32.

• optional ImageData unit_shields_ratio = 19

  uint8. Ratio of current shields to max shields. [0%, 100%] encoded into [0, 255].

• optional ImageData player_relative = 11

  uint8. See "Alliance" enum in raw.proto. Range: [1, 4]

• optional ImageData unit_density_aa = 14

  uint8. Density of units overlapping a pixel, anti-aliased. [0.0, 16.0f] encoded into [0, 255].

• optional ImageData unit_density = 15

  uint8. Count of units overlapping a pixel.

• optional ImageData effects = 20

  uint8. Visuals of persistent abilities. (eg. Psistorm)

• optional ImageData hallucinations = 21

  1-bit. Whether the unit here is a hallucination.

• optional ImageData cloaked = 22

  1-bit. Whether the unit here is cloaked. Hidden units will show up too, but with less details in other layers.

• optional ImageData blip = 23

  1-bit. Whether the unit here is a blip.

• optional ImageData buffs = 24

  int32. One of the buffs applied to this unit. Extras are ignored.

• optional ImageData buff_duration = 26

  uint8. Ratio of buff remaining. [0%, 100%] encoded into [0, 255].

• optional ImageData active = 25

  1-bit. Whether the unit here is active.

• optional ImageData build_progress = 27

  uint8. How far along the building is building something. [0%, 100%] encoded into [0, 255].

• optional ImageData buildable = 28

  1-bit. Whether a building can be built here.

• optional ImageData pathable = 29

  1-bit. Whether a unit can walk here.

• optional ImageData placeholder = 30

  1-bit. Whether the unit here is a placeholder building to be constructed.

Used in: ObservationFeatureLayer

• optional ImageData height_map = 1

  uint8. Terrain height. World space units of [-200, 200] encoded into [0, 255].

• optional ImageData visibility_map = 2

  uint8. 0=Hidden, 1=Fogged, 2=Visible, 3=FullHidden

• optional ImageData creep = 3

  1-bit. Zerg creep.

• optional ImageData camera = 4

  1-bit. Area covered by the camera.

• optional ImageData player_id = 5

  uint8. Participants: [1, 15] Neutral: 16

• optional ImageData player_relative = 6

  uint8. See "Alliance" enum in raw.proto. Range: [1, 4]

• optional ImageData selected = 7

  1-bit. Selected units.

• optional ImageData alerts = 9

  1-bit. Shows 'UnitAttacked' alert location.

• optional ImageData buildable = 10

  1-bit. Whether a building can be built here.

• optional ImageData pathable = 11

  1-bit. Whether a unit can walk here.

• optional ImageData unit_type = 8

  Cheat layers, enable with SpatialCameraSetup.allow_cheating_layers.

  int32. Unique identifier for type of unit.

Used in: FeatureLayers, FeatureLayersMinimap, MapState, ObservationRender, StartRaw

• optional int32 bits_per_pixel = 1

  Number of bits per pixel; 8 bits for a byte etc.

• optional Size2DI size = 2

  Dimension in pixels.

• optional bytes data = 3

  Binary data; the size of this buffer in bytes is width * height * bits_per_pixel / 8.

Used in: RequestJoinGame, RequestStartReplay, ResponseGameInfo

• optional bool raw = 1

  Interface options

• optional bool score = 2

• optional SpatialCameraSetup feature_layer = 3

  Omit to disable.

• optional SpatialCameraSetup render = 4

  Omit to disable.

• optional bool show_cloaked = 5

  By default cloaked units are completely hidden. This shows some details.

• optional bool show_burrowed_shadows = 9

  By default burrowed units are completely hidden. This shows some details for those that produce a shadow.

• optional bool show_placeholders = 8

  Return placeholder units (buildings to be constructed), both for raw and feature layers.

• optional bool raw_affects_selection = 6

  By default raw actions select, act and revert the selection. This is useful if you're playing simultaneously with the agent so it doesn't steal your selection. This inflates APM (due to deselect) and makes the actions hard to follow in a replay. Setting this to true will cause raw actions to do select, act, but not revert the selection.

• optional bool raw_crop_to_playable_area = 7

  Changes the coordinates in raw.proto to be relative to the playable area. The map_size and playable_area will be the diagonal of the real playable area.

Used in: DebugLine

• optional Point p0 = 1

• optional Point p1 = 2

Used in: RequestCreateGame

• optional 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)

• optional bytes map_data = 7

Used in: ObservationRaw

• optional ImageData visibility = 1

  1 byte visibility layer.

• optional ImageData creep = 2

  1 bit creep layer.

Used in: ObservationUI

• repeated UnitInfo units = 1

Used in: ResponseObservation

• optional uint32 game_loop = 9

• optional PlayerCommon player_common = 1

• repeated Alert alerts = 10

• repeated AvailableAbility abilities = 3

  Abilities available in the selection. Enabled if in this list, disabled otherwise.

• optional Score score = 4

• optional ObservationRaw raw_data = 5

  Populated if Raw interface is enabled.

• optional ObservationFeatureLayer feature_layer_data = 6

  Populated if Feature Layer interface is enabled.

• optional ObservationRender render_data = 7

  Populated if Render interface is enabled.

• optional ObservationUI ui_data = 8

  Populated if Feature Layer or Render interface is enabled.

Used in: Observation

• optional FeatureLayers renders = 1

• optional FeatureLayersMinimap minimap_renders = 2

Used in: Observation

• optional PlayerRaw player = 1

• repeated Unit units = 2

• optional MapState map_state = 3

  Fog of war, creep and so on. Board stuff that changes per frame.

• optional Event event = 4

• repeated Effect effects = 5

• repeated RadarRing radar = 6

Used in: Observation

• optional ImageData map = 1

• optional ImageData minimap = 2

Used in: Observation

• repeated ControlGroup groups = 1

• oneof panel

  • SinglePanel single = 2

  • MultiPanel multi = 3

  • CargoPanel cargo = 4

  • ProductionPanel production = 5

Used in: RequestObserverAction

• oneof action

  • ActionObserverPlayerPerspective player_perspective = 1

    Not implemented

  • ActionObserverCameraMove camera_move = 2

  • ActionObserverCameraFollowPlayer camera_follow_player = 3

  • ActionObserverCameraFollowUnits camera_follow_units = 4

    Not implemented

Used in: Unit

• optional uint64 tag = 1

• optional float health = 2

• optional float health_max = 3

• optional float shield = 4

• optional float shield_max = 7

• optional float energy = 5

• optional float energy_max = 8

• optional uint32 unit_type = 6

Used in: Observation

• optional uint32 player_id = 1

• optional uint32 minerals = 2

• optional uint32 vespene = 3

• optional uint32 food_cap = 4

• optional uint32 food_used = 5

• optional uint32 food_army = 6

• optional uint32 food_workers = 7

• optional uint32 idle_worker_count = 8

• optional uint32 army_count = 9

• optional uint32 warp_gate_count = 10

• optional uint32 larva_count = 11

Used in: PlayerInfoExtra, ResponseGameInfo

• optional 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.

• optional PlayerType type = 2

• optional Race race_requested = 3

• optional Race race_actual = 4

  Only populated for your player or when watching replay

• optional Difficulty difficulty = 5

• optional AIBuild ai_build = 7

• optional string player_name = 6

Used in: ResponseReplayInfo

• optional PlayerInfo player_info = 1

• optional PlayerResult player_result = 2

• optional int32 player_mmr = 3

• optional int32 player_apm = 4

Used in: ObservationRaw

• repeated PowerSource power_sources = 1

• optional Point camera = 2

• repeated uint32 upgrade_ids = 3

  TODO: Add to UI observation?

Used in: PlayerInfoExtra, ResponseObservation

• optional uint32 player_id = 1

• optional Result result = 2

Used in: RequestCreateGame

• optional PlayerType type = 1

• optional Race race = 2

  Only used for a computer player.

• optional Difficulty difficulty = 3

• optional string player_name = 4

• optional AIBuild ai_build = 5

Used in: PlayerInfo, PlayerSetup

• Participant = 1

• Computer = 2

• Observer = 3

Point on the game board, 0..255. Note: bottom left of the screen is 0, 0.

Used in: ActionRawCameraMove, DebugBox, DebugSphere, DebugText, Line, PlayerRaw, PowerSource, RadarRing, RallyTarget, Unit, UnitOrder

• optional float x = 1

• optional float y = 2

• optional float z = 3

Point on the game board, 0..255. Note: bottom left of the screen is 0, 0.

Used in: ActionObserverCameraMove, ActionRawUnitCommand, DebugCreateUnit, Effect, RequestQueryBuildingPlacement, RequestQueryPathing, StartRaw

• optional float x = 1

• optional float y = 2

Point on the screen/minimap (e.g., 0..64). Note: bottom left of the screen is 0, 0.

Used in: ActionSpatialCameraMove, ActionSpatialUnitCommand, ActionSpatialUnitSelectionPoint, RectangleI

• optional int32 x = 1

• optional int32 y = 2

Used in: RequestJoinGame

• optional int32 game_port = 1

  Game right now needs two internal ports to establish a multiplay game on the local host.

• optional int32 base_port = 2

Used in: PlayerRaw

• optional Point pos = 1

• optional float radius = 2

• optional uint64 tag = 3

Used in: ObservationUI

• optional UnitInfo unit = 1

• repeated UnitInfo build_queue = 2

  build_queue ONLY gives information about units that are being produced. Use production_queue instead to see both units being trained as well as research in the queue.

• repeated BuildItem production_queue = 3

Used in: PlayerInfo, PlayerSetup, RequestJoinGame, UnitTypeData

• NoRace = 0

• Terran = 1

• Zerg = 2

• Protoss = 3

• Random = 4

Used in: ObservationRaw

• optional Point pos = 1

• optional float radius = 2

Used in: Unit

• optional Point point = 1

  Will always be filled.

• optional uint64 tag = 2

  Only if it's targeting a unit.

Screen space rectangular area.

Used in: ActionSpatialUnitSelectionRect, StartRaw

• optional PointI p0 = 1

• optional PointI p1 = 2

• oneof request

  • RequestCreateGame create_game = 1

    Game Setup

    Send to host to initialize game.

  • RequestJoinGame join_game = 2

    Send to host and all clients for game to begin.

  • RequestRestartGame restart_game = 3

    Single player only. Reinitializes the game with the same player setup.

  • RequestStartReplay start_replay = 4

    Start playing a replay.

  • RequestLeaveGame leave_game = 5

    Multiplayer only. Disconnects from a multiplayer game, equivalent to surrender.

  • RequestQuickSave quick_save = 6

    Saves game to an in-memory bookmark.

  • RequestQuickLoad quick_load = 7

    Loads from an in-memory bookmark.

  • RequestQuit quit = 8

    Terminates the application.

  • RequestGameInfo game_info = 9

    During Game

    Static data about the current game and map.

  • RequestObservation observation = 10

    Snapshot of the current game state.

  • RequestAction action = 11

    Executes an action for a participant.

  • RequestObserverAction obs_action = 21

    Executes an action for an observer.

  • RequestStep step = 12

    Advances the game simulation.

  • RequestData data = 13

    Data about different gameplay elements. May be different for different games.

  • RequestQuery query = 14

    Additional methods for inspecting game state.

  • RequestSaveReplay save_replay = 15

    Generates a replay.

  • RequestMapCommand map_command = 22

    Execute a particular trigger through a string interface

  • RequestReplayInfo replay_info = 16

    Other.

    Returns metadata about a replay file. Does not load the replay.

  • RequestAvailableMaps available_maps = 17

    Returns directory of maps that can be played on.

  • RequestSaveMap save_map = 18

    Saves binary map data to the local temp directory.

  • RequestPing ping = 19

    Debugging

    Network ping for testing connection.

  • RequestDebug debug = 20

    Display debug information and execute debug actions.

• optional uint32 id = 97

-----------------------------------------------------------------------------

Used in: Request

• repeated Action actions = 1

-----------------------------------------------------------------------------

Used in: Request

(message has no fields)

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

Used in: Request

• oneof Map

  • LocalMap local_map = 1

    Local .SC2Map file

  • string battlenet_map_name = 2

    Map published to BattleNet

• repeated PlayerSetup player_setup = 3

• optional bool disable_fog = 4

• optional uint32 random_seed = 5

  Sets the pseudo-random seed for the game.

• optional bool realtime = 6

  If set, the game plays in real time.

-----------------------------------------------------------------------------

Used in: Request

• optional bool ability_id = 1

• optional bool unit_type_id = 2

• optional bool upgrade_id = 3

• optional bool buff_id = 4

• optional bool effect_id = 5

-----------------------------------------------------------------------------

Used in: Request

• repeated DebugCommand debug = 1

-----------------------------------------------------------------------------

Used in: Request

(message has no fields)

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

Used in: Request

• oneof participation

  • Race race = 1

    Join as participant

  • uint32 observed_player_id = 2

    Join as observer

• optional InterfaceOptions options = 3

  This is limited to what is specified in RequestCreateGame, but you can request less information if you want.

• optional PortSet server_ports = 4

  Do not set in the single-player case. This is the port a server will use.

• repeated PortSet client_ports = 5

  Do not set in the single-player case. These are the ports clients will use to initialize communication.

• optional int32 shared_port = 6

  Currently only a singe client is supported.

  deprecated

• optional string player_name = 7

  Use this to set the player's name to something other than autogenerated name.

• optional string host_ip = 8

  Both game creator and joiner should provide the ip address of the game creator in order to play remotely. Defaults to localhost.

-----------------------------------------------------------------------------

Used in: Request

(message has no fields)

-----------------------------------------------------------------------------

Used in: Request

• optional string trigger_cmd = 1

-----------------------------------------------------------------------------

Used in: Request

• optional bool disable_fog = 1

• optional uint32 game_loop = 2

  In realtime the request will only return once the simulation game loop has reached this value. When not realtime this value is ignored.

-----------------------------------------------------------------------------

Used in: Request

• repeated ObserverAction actions = 1

-----------------------------------------------------------------------------

Used in: Request

(message has no fields)

Used in: Request

• repeated RequestQueryPathing pathing = 1

• repeated RequestQueryAvailableAbilities abilities = 2

• repeated RequestQueryBuildingPlacement placements = 3

• optional bool ignore_resource_requirements = 4

  Ignores requirements like food, minerals and so on.

--------------------------------------------------------------------------------------------------

Used in: RequestQuery

• optional uint64 unit_tag = 1

--------------------------------------------------------------------------------------------------

Used in: RequestQuery

• optional int32 ability_id = 1

• optional Point2D target_pos = 2

• optional uint64 placing_unit_tag = 3

  Not required

--------------------------------------------------------------------------------------------------

Used in: RequestQuery

• oneof start

  • Point2D start_pos = 1

  • uint64 unit_tag = 2

• optional Point2D end_pos = 3

-----------------------------------------------------------------------------

Used in: Request

(message has no fields)

-----------------------------------------------------------------------------

Used in: Request

(message has no fields)

-----------------------------------------------------------------------------

Used in: Request

(message has no fields)

-----------------------------------------------------------------------------

Used in: Request

• oneof replay

  • string replay_path = 1

    Limitation: might fail if the replay file is currently loaded.

  • bytes replay_data = 2

• optional bool download_data = 3

  Ensure the data and binary are downloaded if this is an old version replay.

-----------------------------------------------------------------------------

Used in: Request

(message has no fields)

----------------------------------------------------------------------------- Copies map data into the path specified.

Used in: Request

• optional string map_path = 1

  Path the game process will write to, relative to the temp directory. (260 character max)

• optional bytes map_data = 2

  Binary map data of a .SC2Map.

-----------------------------------------------------------------------------

Used in: Request

(message has no fields)

-----------------------------------------------------------------------------

Used in: Request

• oneof replay

  • string replay_path = 1

  • bytes replay_data = 5

• optional bytes map_data = 6

  Overrides the map path stored in the replay.

• optional int32 observed_player_id = 2

• optional InterfaceOptions options = 3

• optional bool disable_fog = 4

• optional bool realtime = 7

• optional bool record_replay = 8

  Allow RequestSaveReplay from a replay. Useful for truncating a replay, or restoring tracker.events.

-----------------------------------------------------------------------------

Used in: Request

• optional uint32 count = 1

  Number of game loops to simulate for the next frame.

• oneof response

  • ResponseCreateGame create_game = 1

  • ResponseJoinGame join_game = 2

  • ResponseRestartGame restart_game = 3

  • ResponseStartReplay start_replay = 4

  • ResponseLeaveGame leave_game = 5

  • ResponseQuickSave quick_save = 6

  • ResponseQuickLoad quick_load = 7

  • ResponseQuit quit = 8

  • ResponseGameInfo game_info = 9

  • ResponseObservation observation = 10

  • ResponseAction action = 11

  • ResponseObserverAction obs_action = 21

  • ResponseStep step = 12

  • ResponseData data = 13

  • ResponseQuery query = 14

  • ResponseSaveReplay save_replay = 15

  • ResponseReplayInfo replay_info = 16

  • ResponseAvailableMaps available_maps = 17

  • ResponseSaveMap save_map = 18

  • ResponseMapCommand map_command = 22

  • ResponsePing ping = 19

    Debugging

  • ResponseDebug debug = 20

• optional uint32 id = 97

• repeated string error = 98

  If command is missing, this will contain the error. Otherwise this will contain any warnings.

• optional Status status = 99

  Should be sent back with all responses.

Used in: Response

• repeated ActionResult result = 1

This 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: Response

• 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.

Used in: Response

• optional ResponseCreateGame.Error error = 1

• optional string error_details = 2

Used in: ResponseCreateGame

• MissingMap = 1

• InvalidMapPath = 2

• InvalidMapData = 3

• InvalidMapName = 4

• InvalidMapHandle = 5

• MissingPlayerSetup = 6

• InvalidPlayerSetup = 7

• MultiplayerUnsupported = 8

  Multiplayer is not supported in the current build.

Used in: Response

• repeated AbilityData abilities = 1

• repeated UnitTypeData units = 2

• repeated UpgradeData upgrades = 3

• repeated BuffData buffs = 4

• repeated EffectData effects = 5

Used in: Response

(message has no fields)

Used in: Response

• optional string map_name = 1

• repeated string mod_names = 6

• optional string local_map_path = 2

• repeated PlayerInfo player_info = 3

• optional StartRaw start_raw = 4

  Populated if Raw interface is enabled.

• optional InterfaceOptions options = 5

Used in: Response

• optional uint32 player_id = 1

• optional ResponseJoinGame.Error error = 2

• optional string error_details = 3

Used in: ResponseJoinGame

• 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

Used in: Response

(message has no fields)

Used in: Response

• optional ResponseMapCommand.Error error = 1

• optional string error_details = 2

Used in: ResponseMapCommand

• NoTriggerError = 1

Used in: Response

• repeated Action actions = 1

  Actions this player did since the last Observation.

• repeated ActionError action_errors = 2

  Equivalent of UI "red text" errors.

• optional Observation observation = 3

• repeated PlayerResult player_result = 4

  Only populated if the game ended during this step.

• repeated ChatReceived chat = 5

Used in: Response

(message has no fields)

Used in: Response

• optional string game_version = 1

• optional string data_version = 2

• optional uint32 data_build = 3

• optional uint32 base_build = 4

Used in: Response

• repeated ResponseQueryPathing pathing = 1

• repeated ResponseQueryAvailableAbilities abilities = 2

• repeated ResponseQueryBuildingPlacement placements = 3

Used in: ResponseQuery

• repeated AvailableAbility abilities = 1

• optional uint64 unit_tag = 2

• optional uint32 unit_type_id = 3

Used in: ResponseQuery

• optional ActionResult result = 1

Used in: ResponseQuery

• optional float distance = 1

  0 if no path exists

-----------------------------------------------------------------------------

Used in: Response

(message has no fields)

-----------------------------------------------------------------------------

Used in: Response

(message has no fields)

Used in: Response

(message has no fields)

Used in: Response

• optional string map_name = 1

• optional string local_map_path = 2

• repeated PlayerInfoExtra player_info = 3

• optional uint32 game_duration_loops = 4

• optional float game_duration_seconds = 5

• optional string game_version = 6

• optional string data_version = 11

• optional uint32 data_build = 7

• optional uint32 base_build = 8

• optional ResponseReplayInfo.Error error = 9

• optional string error_details = 10

Used in: ResponseReplayInfo

• MissingReplay = 1

• InvalidReplayPath = 2

• InvalidReplayData = 3

• ParsingError = 4

• DownloadError = 5

The defaultRestartGameLoops is specified to be (1<<18) by default

Used in: Response

• optional ResponseRestartGame.Error error = 1

• optional string error_details = 2

• optional bool need_hard_reset = 3

  This will occur once the simulation_loop is greater then defaultRestartGameLoops

Used in: ResponseRestartGame

• LaunchError = 1

Used in: Response

• optional ResponseSaveMap.Error error = 1

Used in: ResponseSaveMap

• InvalidMapData = 1

Used in: Response

• optional bytes data = 1

Used in: Response

• optional ResponseStartReplay.Error error = 1

• optional string error_details = 2

Used in: ResponseStartReplay

• MissingReplay = 1

• InvalidReplayPath = 2

• InvalidReplayData = 3

• InvalidMapData = 4

• InvalidObservedPlayerId = 5

• MissingOptions = 6

• LaunchError = 7

Used in: Response

• optional uint32 simulation_loop = 1

  Max simulation_loop is (1<<19) before "end of time" will occur The "end of time" is classified as the maximum number of game loops or absolute game time representable as a positive fixed point number. When we reach the "end of time", permanently pause the game and end the game for all.

Used in: PlayerResult

• Victory = 1

• Defeat = 2

• Tie = 3

• Undecided = 4

Used in: Observation

• optional Score.ScoreType score_type = 6

• optional int32 score = 7

  Note: check score_type to know whether this is a melee score or curriculum score

• optional ScoreDetails score_details = 8

Used in: Score

• Curriculum = 1

  map generated score (from curriculum maps with special scoring)

• Melee = 2

  summation of in-progress and current units/buildings value + minerals + vespene

Used in: Score

• optional 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.

• optional 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.

• optional float total_value_units = 3

  Sum of minerals and vespene spent on completed units.

• optional float total_value_structures = 4

  Sum of minerals and vespene spent on completed structures.

• optional float killed_value_units = 5

  Sum of minerals and vespene of units, belonging to the opponent, that the player has destroyed.

• optional float killed_value_structures = 6

  Sum of minerals and vespene of structures, belonging to the opponent, that the player has destroyed.

• optional float collected_minerals = 7

  Sum of minerals collected by the player.

• optional float collected_vespene = 8

  Sum of vespene collected by the player.

• optional 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.

• optional 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.

• optional 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.

• optional 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 CategoryScoreDetails food_used = 13

  Sum of food, or supply, utilized in the categories above.

• optional CategoryScoreDetails killed_minerals = 14

  Sum of enemies catagories destroyed in minerals.

• optional CategoryScoreDetails killed_vespene = 15

  Sum of enemies catagories destroyed in vespene.

• optional CategoryScoreDetails lost_minerals = 16

  Sum of lost minerals for the player in each category.

• optional CategoryScoreDetails lost_vespene = 17

  Sum of lost vespene for the player in each category.

• optional CategoryScoreDetails friendly_fire_minerals = 18

  Sum of the lost minerals via destroying the players own units/buildings.

• optional CategoryScoreDetails friendly_fire_vespene = 19

  Sum of the lost vespene via destroying the players own units/buildings.

• optional CategoryScoreDetails 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 CategoryScoreDetails 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 CategoryScoreDetails total_used_minerals = 22

  Sum of used minerals throughout the entire game for each category. Unliked used_minerals, this value is never decremented.

• optional CategoryScoreDetails total_used_vespene = 23

  Sum of used vespene throughout the entire game for each category. Unliked used_vespene, this value is never decremented.

• optional VitalScoreDetails total_damage_dealt = 24

  Sum of damage dealt to the player's opponent for each category.

• optional VitalScoreDetails total_damage_taken = 25

  Sum of damage taken by the player for each category.

• optional VitalScoreDetails total_healed = 26

  Sum of health healed by the player. Note that technology can be healed (by queens) or repaired (by scvs).

• optional float current_apm = 27

  Recent raw APM.

• optional float current_effective_apm = 28

  Recent effective APM.

Used in: ObservationUI

• optional UnitInfo unit = 1

• optional int32 attack_upgrade_level = 2

• optional int32 armor_upgrade_level = 3

• optional int32 shield_upgrade_level = 4

• repeated int32 buffs = 5

Screen dimensions.

Used in: ImageData, SpatialCameraSetup, StartRaw

• optional int32 x = 1

• optional int32 y = 2

Used in: InterfaceOptions

• optional Size2DI resolution = 2

• optional Size2DI minimap_resolution = 3

• optional float width = 1

  Below are only relevant for feature layers.

  Set the screen camera width in world units.

• optional bool crop_to_playable_area = 4

  Crop minimap to the playable area.

• optional bool allow_cheating_layers = 5

  Return unit_type on the minimap, and potentially other cheating layers.

Used in: ResponseGameInfo

• optional Size2DI map_size = 1

  Width and height of the map.

• optional ImageData pathing_grid = 2

  1 bit bitmap of the pathing grid.

• optional ImageData terrain_height = 3

  1 byte bitmap of the terrain height.

• optional ImageData placement_grid = 4

  1 bit bitmap of the building placement grid.

• optional RectangleI playable_area = 5

  The playable cells.

• repeated Point2D start_locations = 6

  Possible start locations for players.

Used in: Response

• 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.

Used in: ObservationRaw

• optional DisplayType display_type = 1

  Fields are populated based on type/alliance

• optional Alliance alliance = 2

• optional uint64 tag = 3

  Unique identifier for a unit

• optional uint32 unit_type = 4

• optional int32 owner = 5

• optional Point pos = 6

• optional float facing = 7

• optional float radius = 8

• optional float build_progress = 9

  Range: [0.0, 1.0]

• optional CloakState cloak = 10

• repeated uint32 buff_ids = 27

• optional float detect_range = 31

• optional float radar_range = 32

• optional bool is_selected = 11

• optional bool is_on_screen = 12

  Visible and within the camera frustrum.

• optional bool is_blip = 13

  Detected by sensor tower

• optional bool is_powered = 35

• optional bool is_active = 39

  Building is training/researching (ie animated).

• optional int32 attack_upgrade_level = 40

• optional int32 armor_upgrade_level = 41

• optional int32 shield_upgrade_level = 42

• optional float health = 14

  Not populated for snapshots

• optional float health_max = 15

• optional float shield = 16

• optional float shield_max = 36

• optional float energy = 17

• optional float energy_max = 37

• optional int32 mineral_contents = 18

• optional int32 vespene_contents = 19

• optional bool is_flying = 20

• optional bool is_burrowed = 21

• optional bool is_hallucination = 38

  Unit is your own or detected as a hallucination.

• repeated UnitOrder orders = 22

  Not populated for enemies

• optional uint64 add_on_tag = 23

• repeated PassengerUnit passengers = 24

• optional int32 cargo_space_taken = 25

• optional int32 cargo_space_max = 26

• optional int32 assigned_harvesters = 28

• optional int32 ideal_harvesters = 29

• optional float weapon_cooldown = 30

• optional uint64 engaged_target_tag = 34

• optional int32 buff_duration_remain = 43

  How long a buff or unit is still around (eg mule, broodling, chronoboost).

• optional int32 buff_duration_max = 44

  How long the buff or unit is still around (eg mule, broodling, chronoboost).

• repeated RallyTarget rally_targets = 45

Used in: CargoPanel, MultiPanel, ProductionPanel, SinglePanel

• optional uint32 unit_type = 1

• optional uint32 player_relative = 2

• optional int32 health = 3

• optional int32 shields = 4

• optional int32 energy = 5

• optional int32 transport_slots_taken = 6

• optional float build_progress = 7

  Range: [0.0, 1.0]

• optional UnitInfo add_on = 8

• optional int32 max_health = 9

• optional int32 max_shields = 10

• optional int32 max_energy = 11

Used in: Unit

• optional uint32 ability_id = 1

• oneof target

  • Point target_world_space_pos = 2

  • uint64 target_unit_tag = 3

• optional float progress = 4

  Progress of train abilities. Range: [0.0, 1.0]

Used in: ResponseData

• optional uint32 unit_id = 1

  Stable ID.

• optional string name = 2

  Catalog name of the unit.

• optional bool available = 3

  If true, the ability may be used by this set of mods/map.

• optional uint32 cargo_size = 4

  Number of cargo slots it occupies in transports.

• optional uint32 mineral_cost = 12

• optional uint32 vespene_cost = 13

• optional float food_required = 14

• optional float food_provided = 18

• optional uint32 ability_id = 15

  The ability that builds this unit.

• optional Race race = 16

• optional float build_time = 17

• optional bool has_vespene = 19

• optional bool has_minerals = 20

• optional float sight_range = 25

  Range unit reveals vision.

• repeated uint32 tech_alias = 21

  Other units that satisfy the same tech requirement.

• optional uint32 unit_alias = 22

  The morphed variant of this unit.

• optional uint32 tech_requirement = 23

  Structure required to build this unit. (Or any with the same tech_alias)

• optional bool require_attached = 24

  Whether tech_requirement is an add-on.

• repeated Attribute attributes = 8

  Values include changes from upgrades

• optional float movement_speed = 9

• optional float armor = 10

• repeated Weapon weapons = 11

Used in: ResponseData

• optional uint32 upgrade_id = 1

  Stable ID.

• optional string name = 2

• optional uint32 mineral_cost = 3

• optional uint32 vespene_cost = 4

• optional float research_time = 5

• optional uint32 ability_id = 6

Used in: ScoreDetails

• optional float life = 1

• optional float shields = 2

• optional float energy = 3

Used in: UnitTypeData

• optional Weapon.TargetType type = 1

• optional float damage = 2

• repeated DamageBonus damage_bonus = 3

• optional uint32 attacks = 4

  Number of hits per attack. (eg. Colossus has 2 beams)

• optional float range = 5

• optional float speed = 6

  Time between attacks.

Used in: Weapon

• Ground = 1

• Air = 2

• Any = 3