sc2ai 0.0.4 → 0.0.5

data/data/data_readable.json

@@ -372,7 +372,7 @@
             "allow_autocast": false,
             "allow_minimap": false,
             "buff": [],
-            "cast_range": 9.0,
+            "cast_range": 10.0,
             "cooldown": 0,
             "effect": [],
             "energy_cost": 0,
@@ -11239,7 +11239,7 @@
                 "Mechanical",
                 "Structure"
             ],
-            "gas": 100,
+            "gas": 50,
             "id": 29,
             "is_addon": false,
             "is_flying": false,
@@ -12239,7 +12239,7 @@
                     "cooldown": 1.5,
                     "damage_per_hit": 5.0,
                     "damage_splash": 0,
-                    "range": 0.10009765625,
+                    "range": 0.199951171875,
                     "target_type": "Ground"
                 }
             ]
@@ -13188,7 +13188,7 @@
             "power_radius": 6.5,
             "race": "Protoss",
             "radius": 1.125,
-            "sight": 9.0,
+            "sight": 10.0,
             "size": 0,
             "speed_creep_mul": 1.0,
             "supply": -8.0,
@@ -14293,7 +14293,6 @@
             "accepts_addon": false,
             "armor": 1.0,
             "attributes": [
-                "Light",
                 "Mechanical",
                 "Psionic"
             ],
@@ -14615,7 +14614,7 @@
             "is_townhall": false,
             "is_worker": false,
             "max_health": 40.0,
-            "max_shield": 20.0,
+            "max_shield": 30.0,
             "minerals": 25,
             "name": "Observer",
             "needs_creep": false,
@@ -14629,7 +14628,7 @@
             "speed_creep_mul": 1.0,
             "supply": 1.0,
             "tech_alias": [],
-            "time": 480.0,
+            "time": 400.0,
             "unit_alias": 0,
             "weapons": []
         },
@@ -14872,7 +14871,7 @@
                     "cooldown": 1.5,
                     "damage_per_hit": 5.0,
                     "damage_splash": 0,
-                    "range": 0.10009765625,
+                    "range": 0.199951171875,
                     "target_type": "Ground"
                 }
             ]
@@ -15006,7 +15005,14 @@
             "weapons": []
         },
         {
-            "abilities": [],
+            "abilities": [
+                {
+                    "ability": 1733
+                },
+                {
+                    "ability": 1
+                }
+            ],
             "accepts_addon": false,
             "armor": 0.0,
             "attributes": [
@@ -16127,7 +16133,7 @@
                     "cooldown": 1.5,
                     "damage_per_hit": 5.0,
                     "damage_splash": 0,
-                    "range": 0.10009765625,
+                    "range": 0.199951171875,
                     "target_type": "Ground"
                 }
             ]
@@ -17301,7 +17307,7 @@
             "normal_mode": 111,
             "race": "Zerg",
             "radius": 0.625,
-            "sight": 10.0,
+            "sight": 8.0,
             "size": 0,
             "speed": 2.0,
             "speed_creep_mul": 1.0,
@@ -20011,7 +20017,7 @@
             "is_structure": false,
             "is_townhall": false,
             "is_worker": false,
-            "max_health": 110.0,
+            "max_health": 130.0,
             "minerals": 125,
             "name": "Cyclone",
             "needs_creep": false,
@@ -20036,7 +20042,7 @@
                             "damage": 3.0
                         }
                     ],
-                    "cooldown": 0.673828125,
+                    "cooldown": 0.81201171875,
                     "damage_per_hit": 11.0,
                     "damage_splash": 0,
                     "range": 6.0,
@@ -21422,13 +21428,13 @@
             "radius": 1.0,
             "sight": 11.0,
             "size": 0,
-            "speed": 0.78515625,
+            "speed": 0.9140625,
             "speed_creep_mul": 1.0,
             "supply": -8.0,
             "tech_alias": [
                 106
             ],
-            "time": 266.6796875,
+            "time": 336.015625,
             "unit_alias": 0,
             "weapons": []
         },
@@ -21458,7 +21464,7 @@
             "power_radius": 6.5,
             "race": "Protoss",
             "radius": 1.125,
-            "sight": 9.0,
+            "sight": 10.0,
             "size": 0,
             "speed_creep_mul": 1.0,
             "supply": -8.0,
@@ -21519,9 +21525,6 @@
         },
         {
             "abilities": [
-                {
-                    "ability": 4
-                },
                 {
                     "ability": 4111
                 },
@@ -21587,7 +21590,7 @@
             "is_townhall": false,
             "is_worker": false,
             "max_health": 40.0,
-            "max_shield": 20.0,
+            "max_shield": 30.0,
             "minerals": 25,
             "name": "ObserverSiegeMode",
             "needs_creep": false,
@@ -21900,8 +21903,8 @@
         },
         {
             "cost": {
-                "gas": 175,
-                "minerals": 175,
+                "gas": 150,
+                "minerals": 150,
                 "time": 3040.0
             },
             "id": 8,
@@ -21909,8 +21912,8 @@
         },
         {
             "cost": {
-                "gas": 250,
-                "minerals": 250,
+                "gas": 200,
+                "minerals": 200,
                 "time": 3520.0
             },
             "id": 9,
@@ -21936,8 +21939,8 @@
         },
         {
             "cost": {
-                "gas": 175,
-                "minerals": 175,
+                "gas": 150,
+                "minerals": 150,
                 "time": 3040.0
             },
             "id": 12,
@@ -21945,8 +21948,8 @@
         },
         {
             "cost": {
-                "gas": 250,
-                "minerals": 250,
+                "gas": 200,
+                "minerals": 200,
                 "time": 3520.0
             },
             "id": 13,

data/lib/sc2ai/api/data.rb

@@ -15,10 +15,10 @@ module Sc2
     #   @return [Hash<Integer, Api::AbilityData>]  AbilityId => AbilityData
     attr_accessor :abilities
     # @!attribute units
-    #   @return [Hash<Integer, Api::UnitTypeData>] UnitId => UnitData
+    #   @return [Hash<Integer, Api::UnitTypeData>] UnitId => UnitTypeData
     attr_accessor :units
     # @!attribute upgrades
-    #   @return [Hash<Integer, Api::UnitTypeData>] UnitTypeId => UnitTypeData
+    #   @return [Hash<Integer, Api::UpgradeData>] UpgradeId => UpgradeData
     attr_accessor :upgrades
     # @!attribute buffs
     # Not particularly useful data. Just use BuffId directly
@@ -38,6 +38,8 @@ module Sc2
       @upgrades = upgrades_from_proto(data.upgrades)
       @buffs = buffs_from_proto(data.buffs)
       @effects = effects_from_proto(data.effects)
+
+      override_unit_data
     end
 
     private
@@ -97,5 +99,163 @@ module Sc2
       end
       result
     end
+
+    # @private
+    # Overrides unit data from api to implement fixes or change context
+    # i.e. Api::UnitTypeId::ORBITALCOMMAND cost is cost-to-upgrade instead of CC + Orbital combined cost.
+    # Run once. Depends on all data already being set.
+    def override_unit_data
+      correct_unit_type_costs
+      correct_unit_type_sum
+    end
+
+    # @private
+    # Fixes mineral_cost, vespene_cost and food_required values
+    def correct_unit_type_costs
+      units.transform_values! do |unit_data|
+        # Cost corrections, hardcoded.
+        case unit_data.unit_id
+        when Api::UnitTypeId::CYCLONE # TERRAN - UNITS
+          unit_data.mineral_cost = 125
+          unit_data.vespene_cost = 50
+          unit_data.food_required = 2
+        when Api::UnitTypeId::LIBERATOR
+          unit_data.vespene_cost = 125
+        when Api::UnitTypeId::MULE
+          unit_data.mineral_cost = 0
+        when Api::UnitTypeId::RAVEN
+          unit_data.vespene_cost = 150
+        when Api::UnitTypeId::AUTOTURRET # TERRAN - STRUCTURES
+          unit_data.mineral_cost = 0
+        when Api::UnitTypeId::ORBITALCOMMAND
+          unit_data.mineral_cost = 150
+        when Api::UnitTypeId::PLANETARYFORTRESS
+          unit_data.mineral_cost = 150
+        when Api::UnitTypeId::BANELING # ZERG - UNITS
+          unit_data.mineral_cost = 25
+          unit_data.vespene_cost = 25
+          unit_data.food_required = 0
+        when Api::UnitTypeId::BROODLORD
+          unit_data.mineral_cost = 150
+          unit_data.vespene_cost = 150
+          unit_data.food_required = 0
+        when Api::UnitTypeId::LURKERMP
+          unit_data.mineral_cost = 50
+          unit_data.vespene_cost = 100
+          unit_data.food_required = 0
+        when Api::UnitTypeId::NYDUSCANAL
+          unit_data.mineral_cost = 75
+          unit_data.vespene_cost = 75
+        when Api::UnitTypeId::OVERSEER
+          unit_data.mineral_cost = 50
+        when Api::UnitTypeId::QUEENMP
+          unit_data.mineral_cost = 150
+          unit_data.food_required = 2
+        when Api::UnitTypeId::RAVAGER
+          unit_data.mineral_cost = 25
+          unit_data.vespene_cost = 75
+          unit_data.food_required = 1
+        when Api::UnitTypeId::OVERLORDTRANSPORT
+          unit_data.mineral_cost = 25
+          unit_data.vespene_cost = 25
+        when Api::UnitTypeId::ZERGLING
+          unit_data.mineral_cost = 50
+          unit_data.food_required = 1
+        when Api::UnitTypeId::BANELINGNEST # ZERG - STRUCTURES
+          unit_data.mineral_cost = 100
+        when Api::UnitTypeId::EVOLUTIONCHAMBER
+          unit_data.mineral_cost = 75
+        when Api::UnitTypeId::EXTRACTOR
+          unit_data.mineral_cost = 25
+        when Api::UnitTypeId::GREATERSPIRE
+          unit_data.mineral_cost = 100
+          unit_data.vespene_cost = 150
+        when Api::UnitTypeId::HATCHERY
+          unit_data.mineral_cost = 300
+        when Api::UnitTypeId::HIVE
+          unit_data.mineral_cost = 200
+          unit_data.vespene_cost = 150
+        when Api::UnitTypeId::LAIR
+          unit_data.mineral_cost = 150
+        when Api::UnitTypeId::HYDRALISKDEN
+          unit_data.mineral_cost = 100
+        when Api::UnitTypeId::INFESTATIONPIT
+          unit_data.mineral_cost = 100
+        when Api::UnitTypeId::LURKERDENMP
+          unit_data.mineral_cost = 100
+        when Api::UnitTypeId::NYDUSNETWORK
+          unit_data.mineral_cost = 150
+        when Api::UnitTypeId::ROACHWARREN
+          unit_data.mineral_cost = 150
+        when Api::UnitTypeId::SPAWNINGPOOL
+          unit_data.mineral_cost = 200
+        when Api::UnitTypeId::SPINECRAWLER
+          unit_data.mineral_cost = 100
+        when Api::UnitTypeId::SPIRE
+          unit_data.mineral_cost = 200
+        when Api::UnitTypeId::SPORECRAWLER
+          unit_data.mineral_cost = 75
+        when Api::UnitTypeId::ULTRALISKCAVERN
+          unit_data.mineral_cost = 150
+        when Api::UnitTypeId::ARCHON # PROTOSS - UNITS
+          unit_data.mineral_cost = 0
+          unit_data.vespene_cost = 0
+          unit_data.food_required = 0
+        when Api::UnitTypeId::WARPGATE # PROTOSS - STRUCTURES
+          unit_data.mineral_cost = 0
+        end
+
+        unit_data
+      end
+    end
+
+    # @private
+    # Fixes mineral_cost_sum, vespene_cost_sum
+    def correct_unit_type_sum
+      units.transform_values! do |unit_data|
+        unit_data.mineral_cost_sum = unit_data.mineral_cost
+        unit_data.vespene_cost_sum = unit_data.vespene_cost
+
+        # Cost sums where necessary
+        case unit_data.unit_id
+        when Api::UnitTypeId::OVERSEER, Api::UnitTypeId::OVERLORDTRANSPORT # MORPH TOTALS - UNITS
+          unit_data.mineral_cost_sum += units[Api::UnitTypeId::OVERLORD].mineral_cost
+        when Api::UnitTypeId::BANELING
+          unit_data.mineral_cost_sum += units[Api::UnitTypeId::ZERGLING].mineral_cost / 2.0
+        when Api::UnitTypeId::RAVAGER
+          unit_data.mineral_cost_sum += units[Api::UnitTypeId::ROACH].mineral_cost
+          unit_data.vespene_cost_sum += units[Api::UnitTypeId::ROACH].vespene_cost
+        when Api::UnitTypeId::LURKERMP
+          unit_data.mineral_cost_sum += units[Api::UnitTypeId::HYDRALISK].mineral_cost
+          unit_data.vespene_cost_sum += units[Api::UnitTypeId::HYDRALISK].vespene_cost
+        when Api::UnitTypeId::BROODLORD
+          unit_data.mineral_cost_sum += units[Api::UnitTypeId::CORRUPTOR].mineral_cost
+          unit_data.vespene_cost_sum += units[Api::UnitTypeId::CORRUPTOR].vespene_cost
+        when Api::UnitTypeId::ORBITALCOMMAND, Api::UnitTypeId::PLANETARYFORTRESS # MORPH TOTALS - STRUCTURES
+          unit_data.mineral_cost_sum += units[Api::UnitTypeId::COMMANDCENTER].mineral_cost
+        when Api::UnitTypeId::GREATERSPIRE
+          unit_data.mineral_cost_sum += units[Api::UnitTypeId::SPIRE].mineral_cost
+          unit_data.vespene_cost_sum += units[Api::UnitTypeId::SPIRE].vespene_cost
+        when Api::UnitTypeId::LAIR
+          unit_data.mineral_cost_sum += 300 + units[Api::UnitTypeId::DRONE].mineral_cost
+        when Api::UnitTypeId::HIVE # = Hatchery + Lair + Drone
+          # Hardcode, because sequence isn't guaranteed and chained
+          unit_data.mineral_cost_sum += 450 + units[Api::UnitTypeId::DRONE].mineral_cost
+          unit_data.vespene_cost_sum += 100
+        when Api::UnitTypeId::ARCHON
+          unit_data.mineral_cost_sum = units[Api::UnitTypeId::HIGHTEMPLAR].mineral_cost * 2
+          unit_data.vespene_cost_sum = units[Api::UnitTypeId::HIGHTEMPLAR].vespene_cost * 2
+        when Api::UnitTypeId::WARPGATE
+          unit_data.mineral_cost_sum += units[Api::UnitTypeId::GATEWAY].mineral_cost
+          unit_data.vespene_cost_sum += units[Api::UnitTypeId::GATEWAY].vespene_cost
+        else
+          if unit_data.race == Api::Race::Zerg && unit_data.attributes.include?(:Structure)
+            unit_data.mineral_cost_sum += units[Api::UnitTypeId::DRONE].mineral_cost
+          end
+        end
+
+        unit_data
+      end
+    end
   end
 end

data/lib/sc2ai/api/tech_tree.rb

@@ -77,6 +77,28 @@ module Api
       def upgrade_researched_from(upgrade_id:)
         upgrade_researched_from_data[upgrade_id]
       end
+
+      # Returns the ability which researches this upgrade
+      # @return [Integer] ability_id
+      def upgrade_research_ability_id(upgrade_id:)
+        source_unit_type_id = upgrade_researched_from(upgrade_id:)
+        upgrade_research_abilities_data[source_unit_type_id][upgrade_id][:ability]
+      end
+
+      # Returns a full list of structure unit id's which perform upgrades
+      # This is a useful list when checking if any updates are in progress,
+      # because we scan these structure types for orders
+      # @return [Array<Integer>] unit type ids
+      def upgrade_structure_unit_type_ids
+        @upgrade_structure_unit_type_ids ||= upgrade_research_abilities_data.keys
+      end
+
+      # Returns hash of upgrade info for a specific structure where the upgrade id is the key
+      # @param source_unit_type_id [Integer] source structure unit type id
+      # @return [Hash<Integer, Hash>] ability_id
+      def upgrade_ability_data(source_unit_type_id)
+        upgrade_research_abilities_data[source_unit_type_id]
+      end
     end
   end
 end

data/lib/sc2ai/api/tech_tree_data.rb

@@ -233,6 +233,10 @@ module Api
    Api::UnitTypeId::QUEEN =>
     {ability: Api::AbilityId::TRAINQUEEN_QUEEN,
      required_building: Api::UnitTypeId::SPAWNINGPOOL}},
+                                               Api::UnitTypeId::CREEPTUMOR =>
+  {Api::UnitTypeId::CREEPTUMOR =>
+    {ability: Api::AbilityId::BUILD_CREEPTUMOR_TUMOR,
+     requires_placement_position: true}},
                                                Api::UnitTypeId::SPIRE =>
   {Api::UnitTypeId::GREATERSPIRE =>
     {ability: Api::AbilityId::UPGRADETOGREATERSPIRE_GREATERSPIRE,
@@ -759,6 +763,7 @@ module Api
    Api::UpgradeId::LURKERRANGE =>
     {ability: Api::AbilityId::LURKERDENRESEARCH_RESEARCHLURKERRANGE,
      required_building: Api::UnitTypeId::HIVE}}}
+        .freeze
 
       # unit_created_from_data = {
       #   UnitTypeId.ADEPT: [UnitTypeId.GATEWAY, UnitTypeId.WARPGATE],
@@ -845,6 +850,11 @@ module Api
   [Api::UnitTypeId::HATCHERY,
     Api::UnitTypeId::LAIR,
     Api::UnitTypeId::HIVE],
+                                    Api::UnitTypeId::CREEPTUMOR =>
+  [Api::UnitTypeId::CREEPTUMOR,
+    Api::UnitTypeId::QUEEN,
+    Api::UnitTypeId::CREEPTUMORBURROWED,
+    Api::UnitTypeId::CREEPTUMORQUEEN],
                                     Api::UnitTypeId::GREATERSPIRE => [Api::UnitTypeId::SPIRE],
                                     Api::UnitTypeId::NYDUSCANAL => [Api::UnitTypeId::NYDUSNETWORK],
                                     Api::UnitTypeId::HIVE => [Api::UnitTypeId::LAIR],
@@ -869,10 +879,6 @@ module Api
                                     Api::UnitTypeId::RAVAGER => [Api::UnitTypeId::ROACH],
                                     Api::UnitTypeId::BROODLORD => [Api::UnitTypeId::CORRUPTOR],
                                     Api::UnitTypeId::CREEPTUMORQUEEN => [Api::UnitTypeId::QUEEN],
-                                    Api::UnitTypeId::CREEPTUMOR =>
-  [Api::UnitTypeId::QUEEN,
-    Api::UnitTypeId::CREEPTUMORBURROWED,
-    Api::UnitTypeId::CREEPTUMORQUEEN],
                                     Api::UnitTypeId::CHANGELING =>
   [Api::UnitTypeId::OVERSEER, Api::UnitTypeId::OVERSEERSIEGEMODE],
                                     Api::UnitTypeId::DRONE => [Api::UnitTypeId::LARVA],
@@ -889,6 +895,7 @@ module Api
                                     Api::UnitTypeId::LOCUSTMPFLYING =>
   [Api::UnitTypeId::SWARMHOSTBURROWEDMP, Api::UnitTypeId::SWARMHOSTMP],
                                     Api::UnitTypeId::ORACLESTASISTRAP => [Api::UnitTypeId::ORACLE]}
+        .freeze
 
       # unit_created_from_data = {
       #   UpgradeId.ADEPTPIERCINGATTACK: UnitTypeId.TWILIGHTCOUNCIL,
@@ -993,6 +1000,7 @@ module Api
                                           Api::UpgradeId::TUNNELINGCLAWS => Api::UnitTypeId::ROACHWARREN,
                                           Api::UpgradeId::DIGGINGCLAWS => Api::UnitTypeId::LURKERDENMP,
                                           Api::UpgradeId::LURKERRANGE => Api::UnitTypeId::LURKERDENMP}
+        .freeze
 
       def unit_abilities_data = {Api::UnitTypeId::COLOSSUS =>
   [Api::AbilityId::STOP_STOP,
@@ -1038,7 +1046,7 @@ module Api
     Api::AbilityId::ATTACK_ATTACK,
     Api::AbilityId::EFFECT_MASSRECALL_STRATEGICRECALL,
     Api::AbilityId::EFFECT_TIMEWARP,
-    Api::AbilityId._250MMSTRIKECANNONS_CANCEL,
+    Api::AbilityId._250MMSTRIKECANNONS_250MMSTRIKECANNONS,
     Api::AbilityId::SMART],
                                  Api::UnitTypeId::POINTDEFENSEDRONE => [],
                                  Api::UnitTypeId::CHANGELING =>
@@ -1578,7 +1586,8 @@ module Api
     Api::AbilityId::SMART,
     Api::AbilityId::UPGRADETOLAIR_LAIR,
     Api::AbilityId::TRAINQUEEN_QUEEN],
-                                 Api::UnitTypeId::CREEPTUMOR => [],
+                                 Api::UnitTypeId::CREEPTUMOR =>
+  [Api::AbilityId::BUILD_CREEPTUMOR_TUMOR, Api::AbilityId::SMART],
                                  Api::UnitTypeId::EXTRACTOR => [],
                                  Api::UnitTypeId::SPAWNINGPOOL =>
   [Api::AbilityId::RESEARCH_ZERGLINGMETABOLICBOOST,
@@ -2242,8 +2251,7 @@ module Api
     Api::AbilityId::ATTACK_ATTACK,
     Api::AbilityId::SMART],
                                  Api::UnitTypeId::SHIELDBATTERY =>
-  [Api::AbilityId::STOP_STOP,
-    Api::AbilityId::SHIELDBATTERYRECHARGEEX5_SHIELDBATTERYRECHARGE,
+  [Api::AbilityId::SHIELDBATTERYRECHARGEEX5_SHIELDBATTERYRECHARGE,
     Api::AbilityId::SMART],
                                  Api::UnitTypeId::OBSERVERSIEGEMODE =>
   [Api::AbilityId::STOP_STOP, Api::AbilityId::MORPH_OBSERVERMODE],
@@ -2261,6 +2269,7 @@ module Api
                                  Api::UnitTypeId::REFINERYRICH => [],
                                  Api::UnitTypeId::ASSIMILATORRICH => [],
                                  Api::UnitTypeId::EXTRACTORRICH => []}
+        .freeze
 
       def unit_alias_data = {Api::UnitTypeId::CHANGELINGZEALOT => Api::UnitTypeId::CHANGELING,
                              Api::UnitTypeId::CHANGELINGMARINESHIELD => Api::UnitTypeId::CHANGELING,
@@ -2302,6 +2311,7 @@ module Api
                              Api::UnitTypeId::PYLONOVERCHARGED => Api::UnitTypeId::PYLON,
                              Api::UnitTypeId::OBSERVERSIEGEMODE => Api::UnitTypeId::OBSERVER,
                              Api::UnitTypeId::OVERSEERSIEGEMODE => Api::UnitTypeId::OVERSEER}
+        .freeze
 
       def unit_tech_alias_data = {Api::UnitTypeId::SIEGETANKSIEGED => [Api::UnitTypeId::SIEGETANK],
                                   Api::UnitTypeId::VIKINGASSAULT => [Api::UnitTypeId::VIKING],
@@ -2337,6 +2347,7 @@ module Api
                                   Api::UnitTypeId::PYLONOVERCHARGED =>
   [Api::UnitTypeId::PYLON, Api::UnitTypeId::PYLON],
                                   Api::UnitTypeId::OVERSEERSIEGEMODE => [Api::UnitTypeId::OVERLORD]}
+        .freeze
     end
   end
 end

data/lib/sc2ai/connection.rb

@@ -55,7 +55,7 @@ module Sc2
         # do initial ping to ensure status is set and connection is working
         response_ping = ping
         Sc2.logger.debug { "Game version: #{response_ping.game_version}" }
-      rescue Errno::ECONNREFUSED
+      rescue Errno::ECONNREFUSED, Errno::ECONNRESET
         raise Error, "Connection timeout. Max retry exceeded." unless (attempt += 1) < 30 # 30s attempts
 
         @listeners[ConnectionListener.name]&.each { _1.on_connection_waiting(self) }

data/lib/sc2ai/local_play/client_manager.rb

@@ -10,7 +10,7 @@ module Sc2
 
     class << self
       extend Forwardable
-      def_delegators :instance, :obtain, :get, :start, :stop
+      def_delegators :instance, :obtain, :get, :start, :stop, :stop_all
     end
 
     # Gets client for player X or starts an instance
@@ -53,6 +53,14 @@ module Sc2
       @clients[player_index] = nil
     end
 
+    def stop_all
+      @clients.compact.each do |client|
+        client.stop
+        client = nil
+        @clients.delete(client)
+      end
+    end
+
     private
 
     attr_accessor :clients, :ports

data/lib/sc2ai/player/actions.rb

@@ -64,6 +64,7 @@ module Sc2
       end
 
       # Builds target unit type using units as source at optional target
+      # @param units [Array<Integer>,Integer,Api::Unit] can be an Api::Unit, array of Api::Unit#tag or single tag
       # @param unit_type_id [Integer] Api::UnitTypeId the unit type which will do the creation
       # @param target [Api::Point2D, Integer, nil] is a unit tag or a Api::Point2D. Nil for addons/orbital
       # @param queue_command [Boolean] shift+command
@@ -94,6 +95,22 @@ module Sc2
         subtract_cost(unit_type_id)
       end
 
+      # Research a specific upgrade
+      # @param units [Array<Integer>,Integer,Api::Unit] can be an Api::Unit, array of Api::Unit#tag or single tag
+      # @param upgrade_id [Integer] Api::UpgradeId to research
+      # @param queue_command [Boolean] shift+command
+      def research(units:, upgrade_id:, queue_command: false)
+        upgrade = upgrade_data(upgrade_id)
+
+        # Get build ability from target building type
+        action(units:,
+          ability_id: upgrade.ability_id,
+          queue_command:)
+
+        @spent_minerals += upgrade.mineral_cost
+        @spent_vespene += upgrade.vespene_cost
+      end
+
       # Toggles auto-cast ability for units
       # @param units [Array<Integer>, Integer, Api::Unit] can be an Api::Unit, array of Tags or single Tag
       # @param ability_id [Integer]

data/lib/sc2ai/player/debug.rb

@@ -14,6 +14,7 @@ module Sc2
       # @param debug_command [Api::DebugCommand]
       # @return [void]
       def queue_debug_command(debug_command)
+        @debug_command_queue ||= []
         @debug_command_queue << debug_command
       end
 

data/lib/sc2ai/player/geometry.rb

@@ -259,6 +259,12 @@ module Sc2
         parsed_terrain_height[y.to_i, x.to_i]
       end
 
+      # Returns the terrain height (z) at position x and y for a point
+      # @return [Float] z axis position between -16 and 16
+      def terrain_height_for_pos(position)
+        terrain_height(x: position.x, y: position.y)
+      end
+
       # Returns a parsed terrain_height from bot.game_info.start_raw.
       # Each value in [row][column] holds a float value which is the z height
       # @return [Numo::SFloat] Numo array

data/lib/sc2ai/player/previous_state.rb

@@ -36,13 +36,13 @@ module Sc2
       # Override to modify the previous frame before being set to current
       # @param bot [Sc2::Player::Bot]
       def before_reset(bot)
-        # pp "### before_reset"
+        # no op
       end
 
       # Override to modify previous frame after reset is complete
       # @param bot [Sc2::Player::Bot]
       def after_reset(bot)
-        # pp "### after_reset"
+        # no op
       end
     end
   end