sc2ai 0.5.0 → 0.6.2

data/lib/sc2ai/player/game_state.rb

@@ -27,25 +27,13 @@ module Sc2
       # Access useful game information. Used in parsed pathing grid, terrain height, placement grid.
       # Holds Api::ResponseGameInfo::#start_locations.
       # @return [Api::ResponseGameInfo]
-      def game_info
-        if @game_info_task&.running?
-          @game_info_task&.wait
-          @game_info_task = nil
-        end
-        @game_info
-      end
+      attr_reader :game_info
 
       def game_info=(new_info)
-        @game_info_loop = game_loop
+        @game_info_loop = game_loop || 0
         @game_info = new_info
       end
 
-      # @!attribute game_info_loop
-      #   This is the last loop at which game_info was set.
-      #   Used to determine staleness.
-      # @return [Integer]
-      attr_accessor :game_info_loop
-
       # @!attribute data
       #   @return [Api::ResponseData]
       attr_accessor :data

data/lib/sc2ai/player/geo.rb

@@ -81,6 +81,16 @@ module Sc2
         0..(map_height - 1)
       end
 
+      # Ensures a Sc2::Position's x/y stays in map tile range
+      # Prevents out of bound exceptions when working with minimap
+      # @param position [Sc2::Position, Api::Point2D]
+      # @return [Sc2::Position, Api::Point2D]
+      def clamp_to_grid(position)
+        position.y = position.y.clamp(map_tile_range_y)
+        position.x = position.x.clamp(map_tile_range_x)
+        position
+      end
+
       # Map Parsing functions -----
 
       # Returns whether a x/y (integer) is placeable as per minimap image data.
@@ -300,6 +310,13 @@ module Sc2
           # Fix endian for Numo bit parser
           data = image_data.data.unpack("b*").pack("B*")
           @parsed_pathing_grid = Numo::Bit.from_binary(data, [image_data.size.y, image_data.size.x])
+
+          # Remove erroneous mineral blockers as pathable
+          bot.neutral.select_type(Api::UnitTypeId::MINERALFIELD450).each do |mineral|
+            @parsed_pathing_grid[mineral.pos.y.to_i, mineral.pos.x] = 0
+            @parsed_pathing_grid[mineral.pos.y.to_i, mineral.pos.x - 1] = 0
+          end
+
         end
         @parsed_pathing_grid
       end
@@ -455,7 +472,7 @@ module Sc2
             while inner_y < length
               inner_x = 0
               while inner_x < length
-                if (input_grid[y + inner_y, x + inner_x]).zero?
+                if input_grid[y + inner_y, x + inner_x].zero?
                   output_grid[y / length, x / length] = 0
                   inner_y = length
                   break
@@ -507,7 +524,7 @@ module Sc2
         end
 
         # Split resources by Z axis
-        resources = bot.neutral.minerals + bot.neutral.geysers
+        resources = bot.neutral.minerals.reject_type(Api::UnitTypeId::MINERALFIELD450) + bot.neutral.geysers
         resource_group_z = resources.group_by do |resource|
           resource.pos.z.round # 32 units of Y, most maps will have use 3. round to nearest.
         end

data/lib/sc2ai/player/units.rb

@@ -35,6 +35,11 @@ module Sc2
       #   @return [Sc2::UnitGroup] a group of neutral units
       attr_accessor :effects # not a unit
 
+      # An array of Units which are (red) blips on radar
+      # @!attribute blips
+      #   @return [Sc2::UnitGroup] a group of blip units
+      attr_accessor :blips
+
       # Returns the upgrade ids you have acquired such as weapon upgrade and armor upgrade ids.
       # Shorthand for observation.raw_data.player.upgrade_ids
       # @!attribute [r] upgrades_completed
@@ -254,7 +259,7 @@ module Sc2
 
       # Checks whether you have the resources to construct quantity of unit type
       # @return [Boolean]
-      def can_afford?(unit_type_id:, quantity: 1)
+      def can_afford?(unit_type_id, quantity: 1)
         unit_type_data = unit_data(unit_type_id)
         return false if unit_type_data.nil?
 
@@ -343,10 +348,7 @@ module Sc2
         enemy_alliance = self.enemy_alliance
 
         # To prevent several loops over all units per frame, use this single loop for all checks
-        all_unit_size = observation.raw_data.units.size
-        i = 0
-        while i < all_unit_size
-          unit = observation.raw_data.units[i]
+        observation.raw_data.units.each do |unit|
           tag = unit.tag
           tag = unit.tag = unit.hash if tag.zero?
           # Reluctantly assigning player to unit
@@ -377,7 +379,7 @@ module Sc2
             @neutral[tag] = unit
           end
 
-          # Dont parse callbacks on first loop or for neutral units
+          # Don't parse callbacks on first loop or for neutral units
           if !@previous.all_units.nil? &&
               unit.alliance != :NEUTRAL &&
               unit.display_type != :PLACEHOLDER &&
@@ -392,11 +394,13 @@ module Sc2
               issue_existing_unit_callbacks(unit, previous_unit)
             end
           end
+        end
 
+        # Due to race condition with callbacks and Unit#bot not being set,
+        # rather do a second iteration just for the callbacks
+        observation.raw_data.units.each do |unit|
           # Allow user to fiddle with unit
           on_parse_observation_unit(unit)
-
-          i += 1
         end
       end
 

data/lib/sc2ai/player.rb

@@ -213,6 +213,7 @@ module Sc2
       #     enable_feature_layer = true
       #
       #   end
+      # @return [void]
       def configure
       end
 
@@ -276,12 +277,14 @@ module Sc2
 
       # Override to perform steps before first on_step gets called.
       # Current game_loop is 0 and @api is available
+      # @return [void]
       def on_start
         # Sc2.logger.debug { "#{self.class} on_start" }
       end
 
       # Override to implement your own game logic.
       # Gets called whenever the game moves forward.
+      # @return [void]
       def on_step
         return unless is_a? Bot
 
@@ -305,6 +308,7 @@ module Sc2
       #       puts "Lets try again!"
       #     end
       #   end
+      # @return [void]
       def on_finish(result)
         # Sc2.logger.debug { "#{self.class} on_finish" }
       end
@@ -312,12 +316,14 @@ module Sc2
       # Called when Random race is first detected.
       # Override to handle race identification of random enemy.
       # @param race [Integer] see {Api::Race}
+      # @return [void]
       def on_random_race_detected(race)
       end
 
       # Called on step if errors are present. Equivalent of UI red text errors.
       # Override to read action errors.
       # @param errors [Array<Api::ActionError>]
+      # @return [void]
       def on_action_errors(errors)
         # Sc2.logger.debug errors
       end
@@ -325,6 +331,7 @@ module Sc2
       # Actions this player performed since the last Observation.
       # Override to read actions successfully performed
       # @param actions [Array<Api::Action>] a list of actions which were performed
+      # @return [void]
       def on_actions_performed(actions)
         # Sc2.logger.debug actions
       end
@@ -342,11 +349,13 @@ module Sc2
       #     end
       #   end
       # @param alerts [Array<Integer>] array of Api::Alert::*
+      # @return [void]
       def on_alerts(alerts)
       end
 
       # Callback when upgrades are completed, multiple might finish on the same observation.
       # @param upgrade_ids [Array<Integer>] Api::UpgradeId::*
+      # @return [void]
       def on_upgrades_completed(upgrade_ids)
       end
 
@@ -359,6 +368,7 @@ module Sc2
       # Callback, on observation parse when iterating over every unit
       # Can be useful for decorating additional properties on a unit before on_step
       # A Sc2::Player should override this to decorate additional properties
+      # @return [void]
       def on_parse_observation_unit(unit)
       end
 
@@ -367,12 +377,14 @@ module Sc2
       # Override to use in your bot class or use Player.
       # @param unit [Api::Unit]
       # @see Sc2::Player::Units#units_destroyed
+      # @return [void]
       def on_unit_destroyed(unit)
       end
 
       # Callback for unit created.
       # Override to use in your bot class.
       # @param unit [Api::Unit]
+      # @return [void]
       def on_unit_created(unit)
       end
 
@@ -381,18 +393,21 @@ module Sc2
       # Override to use in your bot class or use Player.
       # @param unit [Api::Unit]
       # @param previous_unit_type_id [Integer] Api::UnitTypeId::*
+      # @return [void]
       def on_unit_type_changed(unit, previous_unit_type_id)
       end
 
       # Callback for structure building began
       # Override to use in your bot class.
       # @param unit [Api::Unit]
+      # @return [void]
       def on_structure_started(unit)
       end
 
       # Callback for structure building is completed
       # Override to use in your bot class or use Player.
       # @param unit [Api::Unit]
+      # @return [void]
       def on_structure_completed(unit)
       end
 
@@ -400,6 +415,7 @@ module Sc2
       # Override to use in your bot class or use Player.
       # @param unit [Api::Unit]
       # @param amount [Integer] of damage
+      # @return [void]
       def on_unit_damaged(unit, amount)
       end
 
@@ -513,8 +529,6 @@ module Sc2
       !IDENTIFIED_RACES.include?(race)
     end
 
-    private
-
     # @private
     CALLBACK_METHODS = %i[on_finish
       on_random_race_detected
@@ -529,19 +543,29 @@ module Sc2
       on_structure_started
       on_structure_completed
       on_unit_damaged]
+    private_constant :CALLBACK_METHODS
+
+    # @private
+    # @return [Array<Symbol>] callbacks implemented on player class
+    attr_accessor :callbacks_defined
 
     # @private
     # Checks if callback method is defined on our bot
     # Used to skip processing on unused callbacks
     # @param callback [Symbol]
     def callback_defined?(callback)
-      CALLBACK_METHODS.include?(callback)
+      if @callbacks_defined.nil?
+        # Cache the intersection check, assuming nobody defines a callback method while actually running
+        @callbacks_defined = CALLBACK_METHODS.intersection(self.class.instance_methods(false))
+      end
+      @callbacks_defined.include?(callback)
     end
 
     # Initialize data on step 0 before stepping and before on_start is called
     def prepare_start
       @data = Sc2::Data.new(@api.data)
       clear_action_queue
+      clear_action_errors
       clear_debug_command_queue
     end
 
@@ -574,6 +598,7 @@ module Sc2
       # Process.clock_gettime(Process::CLOCK_MONOTONIC)
       step_to_loop = @realtime ? game_loop + @step_count : nil
       response_observation = @api.observation(game_loop: step_to_loop)
+      return if response_observation.nil?
 
       # Check if match has a result and callback
       on_player_result(response_observation.player_result) unless response_observation.player_result.empty?
@@ -646,10 +671,7 @@ module Sc2
     # Refreshes bot#game_info ignoring all caches
     # @return [void]
     public def refresh_game_info
-      @game_info_task = Async do
-        self.game_info = @api.game_info
-        @game_info_task = nil
-      end
+      self.game_info = @api.game_info
     end
 
     # Enemy -----------------------

data/lib/sc2ai/protocol/extensions/player_common.rb

@@ -0,0 +1,25 @@
+module Api
+  # Adds additional functionality to message object Api::Point2D
+  module PlayerCommonExt
+    # @!attribute supply_cap
+    #   Maximum supply. alias of #food_cap
+    #   @return [Integer]
+    def supply_cap = food_cap
+
+    # @!attribute supply_used
+    #   Supply used. alias of #food_used
+    #   @return [Integer]
+    def supply_used = food_used
+
+    # @!attribute supply_army
+    #   Supply used for army. alias of #food_army
+    #   @return [Integer]
+    def supply_army = food_army
+
+    # @!attribute supply_workers
+    #   Supply used in workers. alias of #food_workers
+    #   @return [Integer]
+    def supply_workers = food_workers
+  end
+end
+Api::PlayerCommon.prepend Api::PlayerCommonExt

data/lib/sc2ai/protocol/extensions/position.rb

@@ -207,7 +207,7 @@ module Sc2
     # Conversion ---
 
     # Returns [x,y] array tuple
-    # @return [Array[Float,Float]]
+    # @return [Array<Float, Float>]
     def to_axy
       [x, y]
     end

data/lib/sc2ai/protocol/extensions/unit.rb

@@ -23,7 +23,7 @@ module Api
     # Get the unit as from the previous frame. Good for comparison.
     # @return [Api::Unit, nil] this unit from the previous frame or nil if it wasn't present
     def previous
-      @bot.previous.all_units[tag]
+      @bot.previous.all_units&.[](tag)
     end
 
     # Returns whether a unit is alive or not
@@ -48,7 +48,7 @@ module Api
 
     # Attributes ---
 
-    # Returns static [Api::UnitTypeData] for a unit
+    # Returns static an array of attributes for a unit
     # @return [Array<Api::Attribute>]
     def attributes
       unit_data.attributes
@@ -111,7 +111,7 @@ module Api
       has_attribute?(:STRUCTURE)
     end
 
-    # Checks if unit is hover
+    # Checks if unit is hovering
     # @return [Boolean] whether unit has attribute :Hover
     def is_hover?
       has_attribute?(:HOVER)
@@ -133,13 +133,31 @@ module Api
 
     # Helpers for unit properties
 
-    def width = radius * 2
+    def width = radius * 2.0
     # @!parse
     #   # @!attribute width
     #   # width = radius * 2
     #   # @return [Float]
     #   attr_reader :width
 
+    # @!attribute [r] full_health?
+    #   @return [Boolean] health is at maximum
+    def full_health?
+      health == health_max
+    end
+
+    # @!attribute [r] full_shields?
+    #   @return [Boolean] shields are at maximum
+    def full_shields?
+      shield == shield_max
+    end
+
+    # @!attribute [r] full_energy?
+    #   @return [Boolean] energy is at maximum
+    def full_energy?
+      energy == energy_max
+    end
+
     # Some overrides to allow question mark references to boolean properties
 
     # @!attribute [r] is_flying?
@@ -179,6 +197,14 @@ module Api
     # @return [Boolean]
     def is_ground? = !is_flying?
 
+    # @!attribute [r] is_cloaked??
+    # Returns whether the unit is cloaked. Revealed cloak units also return true.
+    # For further distinction, use Unit#cloaked, which uses enum CloakedState
+    # @return [Boolean]
+    def is_cloaked?
+      cloak != :NOT_CLOAKED && cloak != :CLOAKED_UNKNOWN
+    end
+
     # @!endgroup Virtual properties
 
     # Whether unit is effected by buff_id
@@ -315,14 +341,18 @@ module Api
       )
     end
 
-    # Draws a sphere around the unit's attack range
-    # @param weapon_index [Api::Color] default first weapon, see UnitTypeData.weapons
+    # Draws a sphere around the unit's attack range (weapon range + radius)
+    # @param weapon_index [Integer] default first weapon, see UnitTypeData#weapons
     # @param color [Api::Color] optional api color, default red
     def debug_fire_range(weapon_index = 0, color = nil)
+      attack_range = unit_data.weapons[weapon_index]&.range
+      return if attack_range.nil?
+      attack_range += radius
+
       color = Api::Color.new(r: 255, b: 0, g: 0) if color.nil?
-      attack_range = unit_data.weapons[weapon_index].range
       raised_position = pos.dup
       raised_position.z += 0.01
+
       @bot.debug_draw_sphere(point: raised_position, radius: attack_range, color:)
     end
 
@@ -413,22 +443,30 @@ module Api
     end
 
     # Checks whether enemy is within range of weapon or ability and can target ground/air.
-    # Defaults to basic weapon. Pass in ability to override
+    # By default, checks all weapons.
+    # Pass weapon_index or ability_id to target a specific source of damage.
     # @param unit [Api::Unit] enemy
-    # @param weapon_index [Integer] defaults to 0 which is it's basic weapon for it's current form
+    # @param weapon_index [Integer] passing this will select a specific Weapon
     # @param ability_id [Integer] passing this will override weapon Api::AbilityId::*
     # @return [Boolean]
     # @example
+    #   queen.can_attack?(enemy, weapon_index: 0) # Air attack
+    #   queen.can_attack?(enemy, weapon_index: 1) # Ground attack
+    #   queen.can_attack?(enemy) # Auto detect (scans all weapons)
     #   ghost.can_attack?(enemy, weapon_index: 0, ability_id: Api::AbilityId::SNIPE)
-    def can_attack?(unit:, weapon_index: 0, ability_id: nil)
-      if ability_id.nil?
+    def can_attack?(unit:, weapon_index: nil, ability_id: nil)
+      return false if unit.nil?
+      if ability_id
+        # ability
+        ability = @bot.ability_data(ability_id)
+        can_ability_target_unit?(unit:, ability:)
+      elsif weapon_index
         # weapon
         source_weapon = weapon(weapon_index)
         can_weapon_target_unit?(unit:, weapon: source_weapon)
       else
-        # ability
-        ability = @bot.ability_data(ability_id)
-        can_ability_target_unit?(unit:, ability:)
+        # auto-detect weapon
+        unit_data.weapons.any? { |weapon| can_weapon_target_unit?(unit:, weapon:) }
       end
     end
 
@@ -445,6 +483,7 @@ module Api
     # @param weapon [Api::Weapon]
     # @return [Boolean]
     def can_weapon_target_unit?(unit:, weapon:)
+      return false if unit.nil? || weapon.nil?
       # false if enemy is air and we can only shoot ground
       return false if unit.is_flying && weapon.type == :GROUND # Api::Weapon::TargetType::GROUND
 
@@ -455,7 +494,12 @@ module Api
       in_attack_range?(unit:, range: weapon.range)
     end
 
+    # Checks whether an ability can target a unit
+    # @param unit [Api::Unit]
+    # @param ability [Api::AbilityData]
+    # @return [Boolean]
     def can_ability_target_unit?(unit:, ability:)
+      return false if unit.nil? || ability.nil?
       # false if enemy is air and we can only shoot ground
       return false if ability.target == Api::AbilityData::Target::NONE
 
@@ -495,6 +539,7 @@ module Api
     # This value should be correct for building placement math (unit.radius is not good for this)
     # @return [Float] placement radius
     def footprint_radius
+      return 0.0 if unit_data.ability_id == 0
       @bot.data.abilities[unit_data.ability_id].footprint_radius
     end
 

data/lib/sc2ai/protocol/extensions/unit_type_data.rb

@@ -23,6 +23,36 @@ module Api
     #   i.e. 2 for Supply Depot (2x2)
     #   @return [Integer] side-length for placement
     attr_accessor :placement_length
+
+    # @!attribute ground_range
+    #   Ground weapon range or 0.0 when it can't shoot ground
+    #   @return [Float]
+    attr_accessor :ground_range
+
+    # @!attribute air_range
+    #   Air weapon range or 0.0 when it can't shoot air
+    #   @return [Float]
+    attr_accessor :air_range
+
+    # @!attribute ground_damage
+    #   Ground weapon damage or 0.0
+    #   @return [Float]
+    attr_accessor :ground_damage
+
+    # @!attribute air_damage
+    #   Air weapon damage or 0.0
+    #   @return [Float]
+    attr_accessor :air_damage
+
+    # @!attribute ground_dps
+    #   Ground weapon damage per second or 0.0
+    #   @return [Float]
+    attr_accessor :ground_dps
+
+    # @!attribute air_dps
+    #   Air weapon damage per second or 0.0
+    #   @return [Float]
+    attr_accessor :air_dps
   end
 end
 Api::UnitTypeData.prepend Api::UnitTypeDataExtension

data/lib/sc2ai/unit_group/filter_ext.rb

@@ -74,6 +74,18 @@ module Sc2
       Api::UnitTypeId::HATCHERY, Api::UnitTypeId::HIVE, Api::UnitTypeId::LAIR,
       Api::UnitTypeId::NEXUS
     ].freeze
+
+    # An array of passive detector unit types.
+    # Does not include units with detection abilities, such as Oracle/Ghost
+    # @return [Array<Integer>]
+    TYPE_DETECTORS = [
+      Api::UnitTypeId::RAVEN, Api::UnitTypeId::MISSILETURRET,
+      Api::UnitTypeId::OBSERVER, Api::UnitTypeId::OBSERVERSIEGEMODE,
+      Api::UnitTypeId::PHOTONCANNON,
+      Api::UnitTypeId::OVERSEER, Api::UnitTypeId::OVERSEERSIEGEMODE,
+      Api::UnitTypeId::SPORECRAWLER
+    ].freeze
+
     # Returns a new UnitGroup containing all units matching unit type id(s)
     # Multiple values work as an "OR" filter
     # @example
@@ -254,6 +266,12 @@ module Sc2
     alias_method :extractors, :gas
     alias_method :assimilators, :gas
 
+    # Selects units passively have Detection
+    # @return [UnitGroup] gas structures
+    def detectors
+      select_type(TYPE_DETECTORS)
+    end
+
     # Selects only units which have finished constructing, i.o.w. build_progress == 1.0
     # @return [UnitGroup] complete unit group
     def completed
@@ -374,7 +392,7 @@ module Sc2
       select_type(Api::UnitTypeId::CREEPTUMORBURROWED)
     end
 
-    # Protoss ---
+    # PROTOSS ---
 
     # Selects pylons
     # @return [Sc2::UnitGroup] pylons
@@ -416,7 +434,10 @@ module Sc2
     # @param pos [Sc2::Position] unit.pos or a point of any kind
     # @return [Sc2::UnitGroup, Api::Unit, nil] return group or single unit if amount is not supplied
     def nearest_to(pos:, amount: nil)
-      return UnitGroup.new if !amount.nil? && amount.to_i <= 0
+      unless amount.nil?
+        return UnitGroup.new if amount <= 0
+        return self if amount > @units.size
+      end
 
       if use_kdtree
         if amount.nil?

data/lib/sc2ai/version.rb

@@ -1,5 +1,5 @@
 module Sc2
   # gem version
   # @return [String]
-  VERSION = "0.5.0"
+  VERSION = "0.6.2"
 end

data/lib/templates/ladderzip/bin/ladder.tt

@@ -8,13 +8,7 @@ ruby_dir=$base_dir/.ruby
 export PATH=$ruby_dir/bin:$PATH
 export LD_LIBRARY_PATH=$(ruby -e 'puts RbConfig::CONFIG["libdir"]')
 
-# Conservative heap sizes are based on 2x a tested medium-sized game
-export RUBY_GC_HEAP_INIT_SIZE_40_SLOTS=340000
-export RUBY_GC_HEAP_INIT_SIZE_80_SLOTS=50000
-export RUBY_GC_HEAP_INIT_SIZE_160_SLOTS=18000
-export RUBY_GC_HEAP_INIT_SIZE_320_SLOTS=2000
-export RUBY_GC_HEAP_INIT_SIZE_640_SLOTS=1000
-
+export RUBY_YJIT_ENABLE=1
 export AIARENA=true
 sc2ai ladderconfig
 exec sc2ai laddermatch "$@" 1>&2

data/lib/templates/ladderzip/ladderbots.json.tt

@@ -0,0 +1,11 @@
+{
+	"Bots": {
+		"<%= botname %>": {
+			"Race": "<%= Api::Race.lookup($bot.race).to_s.capitalize %>",
+			"Type": "BinaryCpp",
+			"RootPath": "./",
+			"FileName": "<%= botname %>",
+			"Debug": false
+		}
+	}
+}

data/lib/templates/new/.ladderignore

@@ -21,7 +21,7 @@ test/
 tmp/
 .byebug_history
 .bundle/
-vendor/bundle
+vendor/bundle/
 lib/bundler/man/
 
 # Other

data/lib/templates/new/api/data.proto

@@ -89,7 +89,7 @@ message UnitTypeData {
   optional float sight_range = 25;                                // Range unit reveals vision.
 
   repeated uint32 tech_alias = 21 [packed=false];                                // Other units that satisfy the same tech requirement.
-  optional uint32 unit_alias = 22 [packed=false];                                // The morphed variant of this unit.
+  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.

data/lib/templates/new/api/raw.proto

@@ -191,7 +191,7 @@ message ActionRawUnitCommand {
     uint64 target_unit_tag = 3;
   }
   repeated uint64 unit_tags = 4 [packed=false];
-  optional bool queue_command = 5 [packed=false];
+  optional bool queue_command = 5;
 }
 
 message ActionRawCameraMove {

data/lib/templates/new/run_example_match.rb.tt

@@ -1,5 +1,5 @@
 # Use the ladder's boot.rb file and configure there
-require "./boot.rb"
+require_relative "boot"
 
 # Or simply, create by hand
 #my_bot = MyBot.new(name: "Botname", race: Api::Race::RANDOM)