sc2ai 0.0.8 → 0.2.0

data/lib/sc2ai/player/debug.rb

@@ -121,8 +121,8 @@ module Sc2
           draw: Api::DebugDraw.new(
             boxes: [
               Api::DebugBox.new(
-                min: Api::Point.new(x: point.x - radius, y: point.y - radius, z: point.z + 0.02),
-                max: Api::Point.new(x: point.x + radius, y: point.y + radius, z: point.z + (radius * 2) + 0.02),
+                min: Api::Point.new(x: point.x - radius, y: point.y - radius, z: point.z + 0.03),
+                max: Api::Point.new(x: point.x + radius, y: point.y + radius, z: point.z + (radius * 2) + 0.03),
                 color:
               )
             ]
@@ -149,6 +149,40 @@ module Sc2
         )
       end
 
+      # Renders a block on the floor, drawn by 4 lines
+      # Pass in either a pos (Position/Unit) or exact x * y coordinates
+      # Optional indentation adds padding on borders inward
+      # @param pos [Api::Unit, Api::Position]
+      # @param x [Float, Integer]
+      # @param y [Float, Integer]
+      # @param color [Api::Color]
+      # @param indent [Float] default 0.05. should be lower than < 1.0
+      # @example
+      #   debug_tile(x: 12.3, y: 4.56, color: Api::Color.new(r: 255, g: 0, b: 0))
+      #   debug_tile(some_unit)
+      #   debug_tile(some_unit.pos)
+      def debug_tile(pos = nil, x: nil, y: nil, color: nil, indent: 0.05)
+        if pos.is_a?(Api::Unit)
+          x = pos.pos.x.floor
+          y = pos.pos.y.floor
+        elsif pos.is_a?(Sc2::Position)
+          x = pos.pos.x.floor
+          y = pos.pos.y.floor
+        end
+
+        # Raise above floor to prevent texture clipping
+        z = geo.terrain_height(x:, y:).to_f + 0.1
+        tl = Api::Point[x + indent, y + 1.0 - indent, z]
+        bl = Api::Point[x + indent, y + indent, z]
+        br = Api::Point[x + 1.0 - indent, y + indent, z]
+        tr = Api::Point[x + 1.0 - indent, y + 1.0 - indent, z]
+
+        debug_draw_line(p0: tl, p1: bl, color:)
+        debug_draw_line(p0: bl, p1: br, color:)
+        debug_draw_line(p0: br, p1: tr, color:)
+        debug_draw_line(p0: tr, p1: tl, color:)
+      end
+
       # Other Commands ---
 
       # @param command [Integer] one of Api::DebugGameState::*

data/lib/sc2ai/player/{geometry.rb → geo.rb}

@@ -6,7 +6,7 @@ require "rumale/pairwise_metric"
 module Sc2
   class Player
     # Holds map and geography helper functions
-    class Geometry
+    class Geo
       # @!attribute bot
       #   @return [Sc2::Player] player with active connection
       attr_accessor :bot
@@ -98,7 +98,7 @@ module Sc2
         expo_placement_grid[y.to_i, x.to_i] == 1
       end
 
-      # Returns a grid where ony the expo locations are marked
+      # Returns a grid where only the expo locations are marked
       # @return [Numo::Bit]
       def expo_placement_grid
         if @expo_placement_grid.nil?
@@ -111,16 +111,52 @@ module Sc2
             if bot.race == Api::Race::Zerg
               # Reserve one row lower, meaning (y-3) instead of (y-2)
               @expo_placement_grid[(y - 3).clamp(map_tile_range_y)..(y + 2).clamp(map_tile_range_y),
-                                   (x - 2).clamp(map_tile_range_y)..(x + 2).clamp(map_tile_range_y)] = 1
+                                   (x - 2).clamp(map_tile_range_x)..(x + 2).clamp(map_tile_range_x)] = 1
             else
               @expo_placement_grid[(y - 2).clamp(map_tile_range_y)..(y + 2).clamp(map_tile_range_y),
-                                   (x - 2).clamp(map_tile_range_y)..(x + 2).clamp(map_tile_range_y)] = 1
+                                   (x - 2).clamp(map_tile_range_x)..(x + 2).clamp(map_tile_range_x)] = 1
             end
           end
         end
         @expo_placement_grid
       end
 
+      # Returns a grid where only placement obstructions are marked
+      # includes Tumors and lowered Supply Depots
+      # @return [Numo::Bit]
+      private def placement_obstruction_grid
+        # Get obstructing structures
+        obstructure_types = [Api::UnitTypeId::SUPPLYDEPOTLOWERED, Api::UnitTypeId::CREEPTUMORQUEEN, Api::UnitTypeId::CREEPTUMOR, Api::UnitTypeId::CREEPTUMORBURROWED]
+        obstructures = bot.structures.select_type(obstructure_types) + bot.enemy.structures.select_type(obstructure_types)
+        cache_key = obstructures.tags.sort.hash
+
+        # Return cache if obstructing structures haven't changed
+        if !@placement_obstruction_grid.nil? && @placement_obstruction_grid[1] == cache_key
+          return @placement_obstruction_grid[0]
+        end
+        map = Numo::Bit.zeros(map_height, map_width)
+
+        # Cache empty, if no obstructing structures
+        if obstructures.size.zero?
+          @placement_obstruction_grid = [map, cache_key]
+          return map
+        end
+
+        # For each obstructing structure, mark it's tiles with 1's
+        obstructures.each do |structure|
+          x = structure.pos.x.floor
+          y = structure.pos.y.floor
+
+          if structure.unit_type == Api::UnitTypeId::SUPPLYDEPOTLOWERED
+            map[(y - 1)..(y), (x - 1)..(x)] = 1
+          else
+            map[y, x] = 1
+          end
+        end
+        @placement_obstruction_grid = [map, cache_key]
+        map
+      end
+
       # Returns a grid where powered locations are marked true
       # @return [Numo::Bit]
       def parsed_power_grid
@@ -680,7 +716,7 @@ module Sc2
         return @_build_coordinates[cache_key] if !@_build_coordinates[cache_key].nil? && !bot.game_info_stale?
 
         result = []
-        input_grid = parsed_pathing_grid & parsed_placement_grid & ~expo_placement_grid
+        input_grid = parsed_pathing_grid & parsed_placement_grid & ~expo_placement_grid & ~placement_obstruction_grid
         input_grid = if on_creep
           parsed_creep & input_grid
         else

data/lib/sc2ai/player/units.rb

@@ -41,6 +41,12 @@ module Sc2
       #   @return [Array<Integer>] a group of neutral units
       def upgrades_completed = observation&.raw_data&.player&.upgrade_ids.to_a || [] # not a unit
 
+      # Returns true if this upgrade has finished researching
+      # @return [Boolean]
+      def upgrade_completed?(upgrade_id)
+        upgrades_completed.include?(upgrade_id)
+      end
+
       # Returns the upgrade ids which are researching or queued
       # Not set for enemy.
       # @return [Array<Integer>]
@@ -69,7 +75,7 @@ module Sc2
         result - upgrades_completed
       end
 
-      # Returns the upgrade ids which are researching or queued
+      # Returns true if the upgrade is busy researching
       # @return [Boolean]
       def upgrade_in_progress?(upgrade_id)
         structure_unit_type_id = Api::TechTree.upgrade_researched_from(upgrade_id: upgrade_id)
@@ -85,6 +91,17 @@ module Sc2
       # For this unit type, tells you how many are in progress by checking orders for all it's sources.
       # @return [Integer]
       def units_in_progress(unit_type_id)
+        if unit_type_id == Api::UnitTypeId::REACTOR
+          return units_in_progress(Api::UnitTypeId::BARRACKSREACTOR) +
+              units_in_progress(Api::UnitTypeId::FACTORYREACTOR) +
+              units_in_progress(Api::UnitTypeId::STARPORTREACTOR)
+        elsif unit_type_id == Api::UnitTypeId::TECHLAB
+          return units_in_progress(Api::UnitTypeId::BARRACKSTECHLAB) +
+              units_in_progress(Api::UnitTypeId::FACTORYTECHLAB) +
+              units_in_progress(Api::UnitTypeId::STARPORTTECHLAB)
+        end
+
+        # Get source unit
         source_unit_types = Api::TechTree.unit_created_from(unit_type_id: unit_type_id)
 
         # When building from LARVA, check the intermediate models
@@ -113,9 +130,22 @@ module Sc2
         else
           units
         end
+        # For SCV, the structure might be completed but dangling order for a few frames.
+        source_is_scv = source_unit_types.include?(Api::UnitTypeId::SCV)
+
+        # Let's count orders matching the ability
         total_in_progress = origin.select_type(source_unit_types).sum do |source|
           source.orders.count do |order|
-            true if order.ability_id == unit_create_ability
+            if order.ability_id == unit_create_ability
+              if source_is_scv
+                # If we are a SCV, do not count our order if the target is a completed structure pos
+                structures.select_type(unit_type_id).completed.none? do |structure|
+                  structure.pos == order.target_world_space_pos
+                end
+              else
+                true
+              end
+            end
           end
         end
         total_in_progress *= 2 if unit_type_id == Api::UnitTypeId::ZERGLING

data/lib/sc2ai/player.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
+require "forwardable"
+require "numo/narray"
 require_relative "api/data"
 require_relative "connection/connection_listener"
 require_relative "connection/status_listener"
 require_relative "player/game_state"
 require_relative "player/units"
 require_relative "player/previous_state"
-require_relative "player/geometry"
+require_relative "player/geo"
 require_relative "player/actions"
 require_relative "player/debug"
-require "numo/narray"
 
 module Sc2
   # Allows defining Ai, Bot, BotProcess (external), Human or Observer for a Match
@@ -50,12 +51,7 @@ module Sc2
     # @return [Hash]
     attr_accessor :interface_options
 
-    # @return [Api::Race::NoRace] if Observer
-    # @return [Api::Race::Terran] if is_a? Bot, Human, BotProcess
-    # @return [Api::Race::Zerg] if is_a? Bot, Human, BotProcess
-    # @return [Api::Race::Protoss] if is_a? Bot, Human, BotProcess
-    # @return [Api::Race::Random] if specified random and in-game race hasn't been scouted yet
-    # @return [nil] if is_a? forgetful person
+    # @return [Integer] Api::Race enum
     attr_accessor :race
 
     # @return [String] in-game name
@@ -152,7 +148,7 @@ module Sc2
     def join_game(server_host:, port_config:)
       Sc2.logger.debug { "Player \"#{@name}\" joining game..." }
       response = @api.join_game(name: @name, race: @race, server_host:, port_config:, enable_feature_layer: @enable_feature_layer, interface_options: @interface_options)
-      if !response.error.nil? && response.error != :MissingParticipation
+      if response.error != :EnumResponseJoinGameErrorUnset && response.error != :MissingParticipation
         raise Sc2::Error, "Player \"#{@name}\" join_game failed: #{response.error}"
       end
       add_listener(self, klass: Connection::StatusListener)
@@ -188,13 +184,13 @@ module Sc2
       attr_accessor :previous
 
       # @!attribute geo
-      #   @return [Sc2::Player::Geometry] geo and map helper functions
+      #   @return [Sc2::Player::Geo] geo and map helper functions
       attr_accessor :geo
 
       def initialize(race:, name:)
         super(race:, name:, type: Api::PlayerType::Participant, difficulty: nil, ai_build: nil)
         @previous = Sc2::Player::PreviousState.new
-        @geo = Sc2::Player::Geometry.new(self)
+        @geo = Sc2::Player::Geo.new(self)
 
         configure
       end
@@ -231,7 +227,7 @@ module Sc2
         loop do
           r = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
           perform_actions
-          perform_debug_commands # TODO: Detect IS_LADDER? -> unless IS_LADDER?
+          perform_debug_commands unless Sc2.ladder?
           step_forward
           print "\e[2K#{game_loop - @previous.game_loop} Steps Took (ms): #{(::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - r) * 1000}\n\e[1A\r"
           return @result unless @result.nil?
@@ -551,7 +547,6 @@ module Sc2
       # This is better than having a bunch of random zero and nil values
       @previous.reset(self) if @previous.all_units.nil?
 
-      # TODO: remove @events attributes if we don't use them for performance gains
       # Actions performed and errors (only if implemented)
       on_actions_performed(response_observation.actions) unless response_observation.actions.empty?
       on_action_errors(response_observation.action_errors) unless response_observation.action_errors.empty?
@@ -608,41 +603,6 @@ module Sc2
       end
     end
 
-    # Misc -------------------------------
-    # ##TODO: perfect loop implementation
-    # observation has an optional param game_loop and will only return once that step is reached (blocking).
-    # without it, it returns things as they are.
-    # broadly, i think this is what it should be doing, with step_count being minimum of 1, so no zero-steps occur.
-    # @example
-    # desired_game_loop = current_game_loop + step_count
-    # response = client.observation(game_loop: desired_game_loop)
-    #
-    #   if response.game_loop > desired_game_loop {
-    #
-    #     # our requested point-in-time has passed. bot too slow or unlucky timing.
-    #     # so, just re-query things as they stand right now:
-    #     missed_response = response
-    #     # note no game_loop argument supplied this time
-    #     response = client.observation()
-    #
-    #     # Combine observations so you didn't miss anything
-    #     # Merges
-    #     response.actions.merge(missed_response.actions)
-    #     response.action_errors.merge(missed_response.action_errors)
-    #     response.chat.merge(missed_response.chat)
-    #
-    #     # Overrides
-    #     if missed_response.player_result && response.player_result.empty?
-    #       response.player_result = player_result
-    #     end
-    #
-    #       # Note we don't touch reponse.observation and keep the latest
-    #   end
-    #   current_game_loop = response.game_loop
-    #   return response # or dispatch events with it
-    # def perfect_loop
-    # end
-
     private
 
     # @private

data/lib/sc2ai/ports.rb

@@ -124,7 +124,6 @@ module Sc2
       ensure
         # noinspection RubyScope
         socket&.close
-        false
       end
     end
   end

data/lib/sc2ai/protocol/_meta_documentation.rb

@@ -48,12 +48,257 @@
 # @!parse
 #   module Api;
 #     # Protobuf virtual enum.
-#     class Race < Google::Protobuf::AbstractMessage; end;
+#     module Race
+#       NoRace = 0
+#       Terran = 1
+#       Zerg = 2
+#       Protoss = 3
+#       Random = 4
+#     end
 #     # Protobuf virtual enum.
-#     class PlayerType < Google::Protobuf::AbstractMessage; end;
+#     module PlayerType
+#       Participant = 1
+#       Computer = 2
+#       Observer = 3
+#     end
 #     # Protobuf virtual enum.
-#     class Difficulty < Google::Protobuf::AbstractMessage; end;
+#     module Difficulty
+#       VeryEasy = 1
+#       Easy = 2
+#       Medium = 3
+#       MediumHard = 4
+#       Hard = 5
+#       Harder = 6
+#       VeryHard = 7
+#       CheatVision = 8
+#       CheatMoney = 9
+#       CheatInsane = 10
+#     end
 #     # Protobuf virtual enum.
-#     class AIBuild < Google::Protobuf::AbstractMessage; end;
+#     module AIBuild
+#       RandomBuild = 1
+#       Rush = 2
+#       Timing = 3
+#       Power = 4
+#       Macro = 5
+#       Air = 6
+#     end
+#     # Protobuf virtual enum.
+#     module ActionResult
+#       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;
+#     end
 #   end
 # @!parse

data/lib/sc2ai/protocol/common_pb.rb

@@ -5,31 +5,10 @@
 require 'google/protobuf'
 
 
-descriptor_data = "\n\x1bsc2ai/protocol/common.proto\x12\x03\x41pi\">\n\x10\x41vailableAbility\x12\x12\n\nability_id\x18\x01 \x01(\x05\x12\x16\n\x0erequires_point\x18\x02 \x01(\x08\"M\n\tImageData\x12\x16\n\x0e\x62its_per_pixel\x18\x01 \x01(\x05\x12\x1a\n\x04size\x18\x02 \x01(\x0b\x32\x0c.Api.Size2DI\x12\x0c\n\x04\x64\x61ta\x18\x03 \x01(\x0c\"\x1e\n\x06PointI\x12\t\n\x01x\x18\x01 \x01(\x05\x12\t\n\x01y\x18\x02 \x01(\x05\">\n\nRectangleI\x12\x17\n\x02p0\x18\x01 \x01(\x0b\x32\x0b.Api.PointI\x12\x17\n\x02p1\x18\x02 \x01(\x0b\x32\x0b.Api.PointI\"\x1f\n\x07Point2D\x12\t\n\x01x\x18\x01 \x01(\x02\x12\t\n\x01y\x18\x02 \x01(\x02\"(\n\x05Point\x12\t\n\x01x\x18\x01 \x01(\x02\x12\t\n\x01y\x18\x02 \x01(\x02\x12\t\n\x01z\x18\x03 \x01(\x02\"\x1f\n\x07Size2DI\x12\t\n\x01x\x18\x01 \x01(\x05\x12\t\n\x01y\x18\x02 \x01(\x05*A\n\x04Race\x12\n\n\x06NoRace\x10\x00\x12\n\n\x06Terran\x10\x01\x12\x08\n\x04Zerg\x10\x02\x12\x0b\n\x07Protoss\x10\x03\x12\n\n\x06Random\x10\x04"
+descriptor_data = "\n\x1bsc2ai/protocol/common.proto\x12\x03\x41pi\"j\n\x10\x41vailableAbility\x12\x17\n\nability_id\x18\x01 \x01(\x05H\x00\x88\x01\x01\x12\x1b\n\x0erequires_point\x18\x02 \x01(\x08H\x01\x88\x01\x01\x42\r\n\x0b_ability_idB\x11\n\x0f_requires_point\"\x81\x01\n\tImageData\x12\x1b\n\x0e\x62its_per_pixel\x18\x01 \x01(\x05H\x00\x88\x01\x01\x12\x1f\n\x04size\x18\x02 \x01(\x0b\x32\x0c.Api.Size2DIH\x01\x88\x01\x01\x12\x11\n\x04\x64\x61ta\x18\x03 \x01(\x0cH\x02\x88\x01\x01\x42\x11\n\x0f_bits_per_pixelB\x07\n\x05_sizeB\x07\n\x05_data\"4\n\x06PointI\x12\x0e\n\x01x\x18\x01 \x01(\x05H\x00\x88\x01\x01\x12\x0e\n\x01y\x18\x02 \x01(\x05H\x01\x88\x01\x01\x42\x04\n\x02_xB\x04\n\x02_y\"V\n\nRectangleI\x12\x1c\n\x02p0\x18\x01 \x01(\x0b\x32\x0b.Api.PointIH\x00\x88\x01\x01\x12\x1c\n\x02p1\x18\x02 \x01(\x0b\x32\x0b.Api.PointIH\x01\x88\x01\x01\x42\x05\n\x03_p0B\x05\n\x03_p1\"5\n\x07Point2D\x12\x0e\n\x01x\x18\x01 \x01(\x02H\x00\x88\x01\x01\x12\x0e\n\x01y\x18\x02 \x01(\x02H\x01\x88\x01\x01\x42\x04\n\x02_xB\x04\n\x02_y\"I\n\x05Point\x12\x0e\n\x01x\x18\x01 \x01(\x02H\x00\x88\x01\x01\x12\x0e\n\x01y\x18\x02 \x01(\x02H\x01\x88\x01\x01\x12\x0e\n\x01z\x18\x03 \x01(\x02H\x02\x88\x01\x01\x42\x04\n\x02_xB\x04\n\x02_yB\x04\n\x02_z\"5\n\x07Size2DI\x12\x0e\n\x01x\x18\x01 \x01(\x05H\x00\x88\x01\x01\x12\x0e\n\x01y\x18\x02 \x01(\x05H\x01\x88\x01\x01\x42\x04\n\x02_xB\x04\n\x02_y*A\n\x04Race\x12\n\n\x06NoRace\x10\x00\x12\n\n\x06Terran\x10\x01\x12\x08\n\x04Zerg\x10\x02\x12\x0b\n\x07Protoss\x10\x03\x12\n\n\x06Random\x10\x04\x62\x06proto3"
 
 pool = Google::Protobuf::DescriptorPool.generated_pool
-
-begin
-  pool.add_serialized_file(descriptor_data)
-rescue TypeError
-  # Compatibility code: will be removed in the next major version.
-  require 'google/protobuf/descriptor_pb'
-  parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
-  parsed.clear_dependency
-  serialized = parsed.class.encode(parsed)
-  file = pool.add_serialized_file(serialized)
-  warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
-  imports = [
-  ]
-  imports.each do |type_name, expected_filename|
-    import_file = pool.lookup(type_name).file_descriptor
-    if import_file.name != expected_filename
-      warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
-    end
-  end
-  warn "Each proto file must use a consistent fully-qualified name."
-  warn "This will become an error in the next major version."
-end
+pool.add_serialized_file(descriptor_data)
 
 module Api
   AvailableAbility = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("Api.AvailableAbility").msgclass

data/lib/sc2ai/protocol/data_pb.rb

@@ -7,31 +7,10 @@ require 'google/protobuf'
 require 'sc2ai/protocol/common_pb'
 
 
-descriptor_data = "\n\x19sc2ai/protocol/data.proto\x12\x03\x41pi\x1a\x1bsc2ai/protocol/common.proto\"\xb9\x03\n\x0b\x41\x62ilityData\x12\x12\n\nability_id\x18\x01 \x01(\r\x12\x11\n\tlink_name\x18\x02 \x01(\t\x12\x12\n\nlink_index\x18\x03 \x01(\r\x12\x13\n\x0b\x62utton_name\x18\x04 \x01(\t\x12\x15\n\rfriendly_name\x18\x05 \x01(\t\x12\x0e\n\x06hotkey\x18\x06 \x01(\t\x12\x1c\n\x14remaps_to_ability_id\x18\x07 \x01(\r\x12\x11\n\tavailable\x18\x08 \x01(\x08\x12\'\n\x06target\x18\t \x01(\x0e\x32\x17.Api.AbilityData.Target\x12\x15\n\rallow_minimap\x18\n \x01(\x08\x12\x16\n\x0e\x61llow_autocast\x18\x0b \x01(\x08\x12\x13\n\x0bis_building\x18\x0c \x01(\x08\x12\x18\n\x10\x66ootprint_radius\x18\r \x01(\x02\x12\x1c\n\x14is_instant_placement\x18\x0e \x01(\x08\x12\x12\n\ncast_range\x18\x0f \x01(\x02\"I\n\x06Target\x12\x08\n\x04None\x10\x01\x12\t\n\x05Point\x10\x02\x12\x08\n\x04Unit\x10\x03\x12\x0f\n\x0bPointOrUnit\x10\x04\x12\x0f\n\x0bPointOrNone\x10\x05\"?\n\x0b\x44\x61mageBonus\x12!\n\tattribute\x18\x01 \x01(\x0e\x32\x0e.Api.Attribute\x12\r\n\x05\x62onus\x18\x02 \x01(\x02\"\xc1\x01\n\x06Weapon\x12$\n\x04type\x18\x01 \x01(\x0e\x32\x16.Api.Weapon.TargetType\x12\x0e\n\x06\x64\x61mage\x18\x02 \x01(\x02\x12&\n\x0c\x64\x61mage_bonus\x18\x03 \x03(\x0b\x32\x10.Api.DamageBonus\x12\x0f\n\x07\x61ttacks\x18\x04 \x01(\r\x12\r\n\x05range\x18\x05 \x01(\x02\x12\r\n\x05speed\x18\x06 \x01(\x02\"*\n\nTargetType\x12\n\n\x06Ground\x10\x01\x12\x07\n\x03\x41ir\x10\x02\x12\x07\n\x03\x41ny\x10\x03\"\xf4\x03\n\x0cUnitTypeData\x12\x0f\n\x07unit_id\x18\x01 \x01(\r\x12\x0c\n\x04name\x18\x02 \x01(\t\x12\x11\n\tavailable\x18\x03 \x01(\x08\x12\x12\n\ncargo_size\x18\x04 \x01(\r\x12\x14\n\x0cmineral_cost\x18\x0c \x01(\r\x12\x14\n\x0cvespene_cost\x18\r \x01(\r\x12\x15\n\rfood_required\x18\x0e \x01(\x02\x12\x15\n\rfood_provided\x18\x12 \x01(\x02\x12\x12\n\nability_id\x18\x0f \x01(\r\x12\x17\n\x04race\x18\x10 \x01(\x0e\x32\t.Api.Race\x12\x12\n\nbuild_time\x18\x11 \x01(\x02\x12\x13\n\x0bhas_vespene\x18\x13 \x01(\x08\x12\x14\n\x0chas_minerals\x18\x14 \x01(\x08\x12\x13\n\x0bsight_range\x18\x19 \x01(\x02\x12\x12\n\ntech_alias\x18\x15 \x03(\r\x12\x12\n\nunit_alias\x18\x16 \x01(\r\x12\x18\n\x10tech_requirement\x18\x17 \x01(\r\x12\x18\n\x10require_attached\x18\x18 \x01(\x08\x12\"\n\nattributes\x18\x08 \x03(\x0e\x32\x0e.Api.Attribute\x12\x16\n\x0emovement_speed\x18\t \x01(\x02\x12\r\n\x05\x61rmor\x18\n \x01(\x02\x12\x1c\n\x07weapons\x18\x0b \x03(\x0b\x32\x0b.Api.Weapon\"\x86\x01\n\x0bUpgradeData\x12\x12\n\nupgrade_id\x18\x01 \x01(\r\x12\x0c\n\x04name\x18\x02 \x01(\t\x12\x14\n\x0cmineral_cost\x18\x03 \x01(\r\x12\x14\n\x0cvespene_cost\x18\x04 \x01(\r\x12\x15\n\rresearch_time\x18\x05 \x01(\x02\x12\x12\n\nability_id\x18\x06 \x01(\r\")\n\x08\x42uffData\x12\x0f\n\x07\x62uff_id\x18\x01 \x01(\r\x12\x0c\n\x04name\x18\x02 \x01(\t\"T\n\nEffectData\x12\x11\n\teffect_id\x18\x01 \x01(\r\x12\x0c\n\x04name\x18\x02 \x01(\t\x12\x15\n\rfriendly_name\x18\x03 \x01(\t\x12\x0e\n\x06radius\x18\x04 \x01(\x02*\x9e\x01\n\tAttribute\x12\t\n\x05Light\x10\x01\x12\x0b\n\x07\x41rmored\x10\x02\x12\x0e\n\nBiological\x10\x03\x12\x0e\n\nMechanical\x10\x04\x12\x0b\n\x07Robotic\x10\x05\x12\x0b\n\x07Psionic\x10\x06\x12\x0b\n\x07Massive\x10\x07\x12\r\n\tStructure\x10\x08\x12\t\n\x05Hover\x10\t\x12\n\n\x06Heroic\x10\n\x12\x0c\n\x08Summoned\x10\x0b"
+descriptor_data = "\n\x19sc2ai/protocol/data.proto\x12\x03\x41pi\x1a\x1bsc2ai/protocol/common.proto\"\x96\x06\n\x0b\x41\x62ilityData\x12\x17\n\nability_id\x18\x01 \x01(\rH\x00\x88\x01\x01\x12\x16\n\tlink_name\x18\x02 \x01(\tH\x01\x88\x01\x01\x12\x17\n\nlink_index\x18\x03 \x01(\rH\x02\x88\x01\x01\x12\x18\n\x0b\x62utton_name\x18\x04 \x01(\tH\x03\x88\x01\x01\x12\x1a\n\rfriendly_name\x18\x05 \x01(\tH\x04\x88\x01\x01\x12\x13\n\x06hotkey\x18\x06 \x01(\tH\x05\x88\x01\x01\x12!\n\x14remaps_to_ability_id\x18\x07 \x01(\rH\x06\x88\x01\x01\x12\x16\n\tavailable\x18\x08 \x01(\x08H\x07\x88\x01\x01\x12,\n\x06target\x18\t \x01(\x0e\x32\x17.Api.AbilityData.TargetH\x08\x88\x01\x01\x12\x1a\n\rallow_minimap\x18\n \x01(\x08H\t\x88\x01\x01\x12\x1b\n\x0e\x61llow_autocast\x18\x0b \x01(\x08H\n\x88\x01\x01\x12\x18\n\x0bis_building\x18\x0c \x01(\x08H\x0b\x88\x01\x01\x12\x1d\n\x10\x66ootprint_radius\x18\r \x01(\x02H\x0c\x88\x01\x01\x12!\n\x14is_instant_placement\x18\x0e \x01(\x08H\r\x88\x01\x01\x12\x17\n\ncast_range\x18\x0f \x01(\x02H\x0e\x88\x01\x01\"^\n\x06Target\x12\x13\n\x0f\x45numTargetUnset\x10\x00\x12\x08\n\x04None\x10\x01\x12\t\n\x05Point\x10\x02\x12\x08\n\x04Unit\x10\x03\x12\x0f\n\x0bPointOrUnit\x10\x04\x12\x0f\n\x0bPointOrNone\x10\x05\x42\r\n\x0b_ability_idB\x0c\n\n_link_nameB\r\n\x0b_link_indexB\x0e\n\x0c_button_nameB\x10\n\x0e_friendly_nameB\t\n\x07_hotkeyB\x17\n\x15_remaps_to_ability_idB\x0c\n\n_availableB\t\n\x07_targetB\x10\n\x0e_allow_minimapB\x11\n\x0f_allow_autocastB\x0e\n\x0c_is_buildingB\x13\n\x11_footprint_radiusB\x17\n\x15_is_instant_placementB\r\n\x0b_cast_range\"a\n\x0b\x44\x61mageBonus\x12&\n\tattribute\x18\x01 \x01(\x0e\x32\x0e.Api.AttributeH\x00\x88\x01\x01\x12\x12\n\x05\x62onus\x18\x02 \x01(\x02H\x01\x88\x01\x01\x42\x0c\n\n_attributeB\x08\n\x06_bonus\"\xa7\x02\n\x06Weapon\x12)\n\x04type\x18\x01 \x01(\x0e\x32\x16.Api.Weapon.TargetTypeH\x00\x88\x01\x01\x12\x13\n\x06\x64\x61mage\x18\x02 \x01(\x02H\x01\x88\x01\x01\x12&\n\x0c\x64\x61mage_bonus\x18\x03 \x03(\x0b\x32\x10.Api.DamageBonus\x12\x14\n\x07\x61ttacks\x18\x04 \x01(\rH\x02\x88\x01\x01\x12\x12\n\x05range\x18\x05 \x01(\x02H\x03\x88\x01\x01\x12\x12\n\x05speed\x18\x06 \x01(\x02H\x04\x88\x01\x01\"C\n\nTargetType\x12\x17\n\x13\x45numTargetTypeUnset\x10\x00\x12\n\n\x06Ground\x10\x01\x12\x07\n\x03\x41ir\x10\x02\x12\x07\n\x03\x41ny\x10\x03\x42\x07\n\x05_typeB\t\n\x07_damageB\n\n\x08_attacksB\x08\n\x06_rangeB\x08\n\x06_speed\"\xf9\x06\n\x0cUnitTypeData\x12\x14\n\x07unit_id\x18\x01 \x01(\rH\x00\x88\x01\x01\x12\x11\n\x04name\x18\x02 \x01(\tH\x01\x88\x01\x01\x12\x16\n\tavailable\x18\x03 \x01(\x08H\x02\x88\x01\x01\x12\x17\n\ncargo_size\x18\x04 \x01(\rH\x03\x88\x01\x01\x12\x19\n\x0cmineral_cost\x18\x0c \x01(\rH\x04\x88\x01\x01\x12\x19\n\x0cvespene_cost\x18\r \x01(\rH\x05\x88\x01\x01\x12\x1a\n\rfood_required\x18\x0e \x01(\x02H\x06\x88\x01\x01\x12\x1a\n\rfood_provided\x18\x12 \x01(\x02H\x07\x88\x01\x01\x12\x17\n\nability_id\x18\x0f \x01(\rH\x08\x88\x01\x01\x12\x1c\n\x04race\x18\x10 \x01(\x0e\x32\t.Api.RaceH\t\x88\x01\x01\x12\x17\n\nbuild_time\x18\x11 \x01(\x02H\n\x88\x01\x01\x12\x18\n\x0bhas_vespene\x18\x13 \x01(\x08H\x0b\x88\x01\x01\x12\x19\n\x0chas_minerals\x18\x14 \x01(\x08H\x0c\x88\x01\x01\x12\x18\n\x0bsight_range\x18\x19 \x01(\x02H\r\x88\x01\x01\x12\x12\n\ntech_alias\x18\x15 \x03(\r\x12\x17\n\nunit_alias\x18\x16 \x01(\rH\x0e\x88\x01\x01\x12\x1d\n\x10tech_requirement\x18\x17 \x01(\rH\x0f\x88\x01\x01\x12\x1d\n\x10require_attached\x18\x18 \x01(\x08H\x10\x88\x01\x01\x12\"\n\nattributes\x18\x08 \x03(\x0e\x32\x0e.Api.Attribute\x12\x1b\n\x0emovement_speed\x18\t \x01(\x02H\x11\x88\x01\x01\x12\x12\n\x05\x61rmor\x18\n \x01(\x02H\x12\x88\x01\x01\x12\x1c\n\x07weapons\x18\x0b \x03(\x0b\x32\x0b.Api.WeaponB\n\n\x08_unit_idB\x07\n\x05_nameB\x0c\n\n_availableB\r\n\x0b_cargo_sizeB\x0f\n\r_mineral_costB\x0f\n\r_vespene_costB\x10\n\x0e_food_requiredB\x10\n\x0e_food_providedB\r\n\x0b_ability_idB\x07\n\x05_raceB\r\n\x0b_build_timeB\x0e\n\x0c_has_vespeneB\x0f\n\r_has_mineralsB\x0e\n\x0c_sight_rangeB\r\n\x0b_unit_aliasB\x13\n\x11_tech_requirementB\x13\n\x11_require_attachedB\x11\n\x0f_movement_speedB\x08\n\x06_armor\"\xff\x01\n\x0bUpgradeData\x12\x17\n\nupgrade_id\x18\x01 \x01(\rH\x00\x88\x01\x01\x12\x11\n\x04name\x18\x02 \x01(\tH\x01\x88\x01\x01\x12\x19\n\x0cmineral_cost\x18\x03 \x01(\rH\x02\x88\x01\x01\x12\x19\n\x0cvespene_cost\x18\x04 \x01(\rH\x03\x88\x01\x01\x12\x1a\n\rresearch_time\x18\x05 \x01(\x02H\x04\x88\x01\x01\x12\x17\n\nability_id\x18\x06 \x01(\rH\x05\x88\x01\x01\x42\r\n\x0b_upgrade_idB\x07\n\x05_nameB\x0f\n\r_mineral_costB\x0f\n\r_vespene_costB\x10\n\x0e_research_timeB\r\n\x0b_ability_id\"H\n\x08\x42uffData\x12\x14\n\x07\x62uff_id\x18\x01 \x01(\rH\x00\x88\x01\x01\x12\x11\n\x04name\x18\x02 \x01(\tH\x01\x88\x01\x01\x42\n\n\x08_buff_idB\x07\n\x05_name\"\x9c\x01\n\nEffectData\x12\x16\n\teffect_id\x18\x01 \x01(\rH\x00\x88\x01\x01\x12\x11\n\x04name\x18\x02 \x01(\tH\x01\x88\x01\x01\x12\x1a\n\rfriendly_name\x18\x03 \x01(\tH\x02\x88\x01\x01\x12\x13\n\x06radius\x18\x04 \x01(\x02H\x03\x88\x01\x01\x42\x0c\n\n_effect_idB\x07\n\x05_nameB\x10\n\x0e_friendly_nameB\t\n\x07_radius*\xb6\x01\n\tAttribute\x12\x16\n\x12\x45numAttributeUnset\x10\x00\x12\t\n\x05Light\x10\x01\x12\x0b\n\x07\x41rmored\x10\x02\x12\x0e\n\nBiological\x10\x03\x12\x0e\n\nMechanical\x10\x04\x12\x0b\n\x07Robotic\x10\x05\x12\x0b\n\x07Psionic\x10\x06\x12\x0b\n\x07Massive\x10\x07\x12\r\n\tStructure\x10\x08\x12\t\n\x05Hover\x10\t\x12\n\n\x06Heroic\x10\n\x12\x0c\n\x08Summoned\x10\x0b\x62\x06proto3"
 
 pool = Google::Protobuf::DescriptorPool.generated_pool
-
-begin
-  pool.add_serialized_file(descriptor_data)
-rescue TypeError
-  # Compatibility code: will be removed in the next major version.
-  require 'google/protobuf/descriptor_pb'
-  parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
-  parsed.clear_dependency
-  serialized = parsed.class.encode(parsed)
-  file = pool.add_serialized_file(serialized)
-  warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
-  imports = [
-  ]
-  imports.each do |type_name, expected_filename|
-    import_file = pool.lookup(type_name).file_descriptor
-    if import_file.name != expected_filename
-      warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
-    end
-  end
-  warn "Each proto file must use a consistent fully-qualified name."
-  warn "This will become an error in the next major version."
-end
+pool.add_serialized_file(descriptor_data)
 
 module Api
   AbilityData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("Api.AbilityData").msgclass