sc2ai 0.6.5 → 0.8.0

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

@@ -39,9 +39,50 @@ module Api
       new_unit = @bot.all_units[tag]
       return false if new_unit.nil? || new_unit == self
 
-      method(:initialize).parameters.each do |_, entry|
-        send(:"#{entry.name}=", new_unit.send(entry))
-      end
+      self.display_type = new_unit.display_type
+      self.alliance = new_unit.alliance
+      self.tag = new_unit.tag
+      self.unit_type = new_unit.unit_type
+      self.owner = new_unit.owner
+      self.pos = new_unit.pos
+      self.facing = new_unit.facing
+      self.radius = new_unit.radius
+      self.build_progress = new_unit.build_progress
+      self.cloak = new_unit.cloak
+      self.buff_ids = new_unit.buff_ids
+      self.detect_range = new_unit.detect_range
+      self.radar_range = new_unit.radar_range
+      self.is_selected = new_unit.is_selected
+      self.is_on_screen = new_unit.is_on_screen
+      self.is_blip = new_unit.is_blip
+      self.is_powered = new_unit.is_powered
+      self.is_active = new_unit.is_active
+      self.attack_upgrade_level = new_unit.attack_upgrade_level
+      self.armor_upgrade_level = new_unit.armor_upgrade_level
+      self.shield_upgrade_level = new_unit.shield_upgrade_level
+      self.health = new_unit.health
+      self.health_max = new_unit.health_max
+      self.shield = new_unit.shield
+      self.shield_max = new_unit.shield_max
+      self.energy = new_unit.energy
+      self.energy_max = new_unit.energy_max
+      self.mineral_contents = new_unit.mineral_contents
+      self.vespene_contents = new_unit.vespene_contents
+      self.is_flying = new_unit.is_flying
+      self.is_burrowed = new_unit.is_burrowed
+      self.is_hallucination = new_unit.is_hallucination
+      self.orders = new_unit.orders
+      self.add_on_tag = new_unit.add_on_tag
+      self.passengers = new_unit.passengers
+      self.cargo_space_taken = new_unit.cargo_space_taken
+      self.cargo_space_max = new_unit.cargo_space_max
+      self.assigned_harvesters = new_unit.assigned_harvesters
+      self.ideal_harvesters = new_unit.ideal_harvesters
+      self.weapon_cooldown = new_unit.weapon_cooldown
+      self.engaged_target_tag = new_unit.engaged_target_tag
+      self.buff_duration_remain = new_unit.buff_duration_remain
+      self.buff_duration_max = new_unit.buff_duration_max
+      self.rally_targets = new_unit.rally_targets
 
       true
     end
@@ -157,6 +198,24 @@ module Api
       energy == energy_max
     end
 
+    # Returns whether this is a melee (non-ranged) attacker
+    # Archon isn't melee; 3 range
+    # Hellbat is melee, but Hellion isn't melee; 5 range
+    # Roach isn't melee; just an attack animation when nearby
+    # @!attribute [r] is_melee?
+    #   @return [Boolean] melee unit (non-ranged attacker)
+    def is_melee?
+      Sc2::UnitGroup::TYPE_MELEE.include?(unit_type)
+    end
+
+    # Returns ranged attack units
+    # @see Sc2::UnitGroup::TYPE_RANGE
+    # @!attribute [r] is_ranged?
+    #   @return [Boolean] if reasonably considered a ranged attacker
+    def is_ranged?
+      Sc2::UnitGroup::TYPE_RANGE.include?(unit_type)
+    end
+
     # Some overrides to allow question mark references to boolean properties
 
     # @!attribute [r] is_flying?
@@ -593,7 +652,7 @@ module Api
         Api::UnitTypeId::STARPORTREACTOR
       end
 
-      build(unit_type_id: unit_type_id, target: target_for_addon_placement, queue_command:)
+      build(unit_type_id: unit_type_id, target:, queue_command:)
     end
 
     # For Terran builds a tech lab add-on on the current structure
@@ -607,21 +666,7 @@ module Api
       when Api::UnitTypeId::STARPORT, Api::UnitTypeId::STARPORTFLYING
         Api::UnitTypeId::STARPORTTECHLAB
       end
-      build(unit_type_id: unit_type_id, target: target_for_addon_placement, queue_command:)
-    end
-
-    private def target_for_addon_placement
-      # Attempts to auto-move left if not placeable
-      x = pos.x.floor
-      y = pos.y.floor
-      if !bot.geo.placeable?(x: x + 3, y: y - 1) ||
-          !bot.geo.placeable?(x: x + 3, y: y) ||
-          !bot.geo.placeable?(x: x + 2, y: y - 1) ||
-          !bot.geo.placeable?(x: x + 2, y: y)
-        return Api::Point2D[pos.x - 1, pos.y]
-      end
-
-      nil
+      build(unit_type_id: unit_type_id, target:, queue_command:)
     end
 
     # PROTOSS Convenience functions ---

data/lib/sc2ai/step_timer.rb

@@ -0,0 +1,134 @@
+module Sc2
+  # Tracks various metrics about your step time performance.
+  class StepTimer
+    TRUNCATED_TIME_RANGE = 0..999.99
+    HEALTHY_STEP_TIME_MS = (1000.0 / 22.4)
+    private_constant :TRUNCATED_TIME_RANGE, :HEALTHY_STEP_TIME_MS
+
+    # @!attribute [r] avg_real_time
+    # @return [Float] Realtime average time per step in ms. Includes SC2 wait time
+    attr_reader :avg_real_time
+
+    # @!attribute [r] avg_step_time
+    # @return [Float] Total average time per step in ms. "Ladder Time" as measured by aiarena
+    attr_reader :avg_step_time
+
+    # @!attribute [r] recent_average
+    # @return [Float] Running average time per step in ms for recent couple of steps
+    attr_accessor :avg_recent_step_time
+
+    # @!attribute [r] previous_on_step_time
+    # @return [Float] Previous on_step took this amount of ms to run
+    attr_reader :previous_on_step_time
+
+    # @!attribute [r] previous_on_step_count
+    # @return [Integer] Number of frames which passed previous on_step
+    attr_reader :previous_on_step_count
+
+    # @private
+    private attr_accessor :bot
+    # @private
+    private attr_accessor :previous_external_time, :previous_update_time
+    # @private
+    private attr_accessor :recent_sum_time, :recent_sum_steps, :recent_update_counter
+
+    # @private
+    # @param bot [Sc2::Player]
+    def initialize(bot)
+      @bot = bot
+
+      # Tracking vars
+      @previous_external_time = @bot.api.external_time
+      @previous_update_time = Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_millisecond)
+      @recent_update_counter = 0
+      @recent_sum_steps = 0
+      @recent_sum_time = 0.0
+      @total_step_time = 0.0
+      @total_real_time = 0.0
+
+      # Output vars
+      @avg_real_time = 0.0
+      @avg_step_time = 0.0
+      @avg_recent_step_time = 0.0
+      @previous_on_step_time = 0.0
+      @previous_on_step_count = 0
+    end
+
+    # How much time we have left in this step, to be healthy
+    def allowance
+      return 0.0 if @bot.realtime
+      time_passed = Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_millisecond) - @previous_update_time
+      external_delta = @bot.api.external_time - @previous_external_time
+      (HEALTHY_STEP_TIME_MS * @bot.step_count) - (time_passed - external_delta)
+    end
+
+    # A one-line string summary of all tracked times
+    # @return [String]
+    def summary
+      "AVG Real: #{format_time(@avg_real_time)} | " \
+        "AVG Total: #{format_time(@avg_step_time)} | " \
+        "AVG Recent: #{format_time(@avg_recent_step_time)} | " \
+        "Previous #{@previous_on_step_count} Step(s): #{format_time(@previous_on_step_time)} (ms)"
+    end
+
+    # A hash containing :avg_real_time, :avg_step_time, :avg_recent_step_time, :previous_on_step_count, :previous_on_step_time
+    # @return [Hash]
+    def to_h
+      {
+        avg_real_time: avg_real_time,
+        avg_step_time: avg_step_time,
+        avg_recent_step_time: avg_recent_step_time,
+        previous_on_step_count: previous_on_step_count,
+        previous_on_step_time: previous_on_step_time
+      }
+    end
+
+    def update
+      # Number of steps which have passed
+      step_delta = @bot.game_loop - @bot.previous.game_loop
+
+      # Time spent waiting for SC2 is not counted on ladder
+      external_time = @bot.api.external_time
+      external_delta = external_time - @previous_external_time
+      @previous_external_time = external_time
+
+      # Start calculating...
+      now = Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_millisecond)
+
+      time_delta = now - @previous_update_time
+      @previous_update_time = now
+
+      # Update real time
+      @total_real_time += time_delta
+
+      # Update step time (excl external)
+      time_delta -= external_delta
+      @total_step_time += time_delta
+
+      # Write public values...
+      @previous_on_step_time = time_delta
+      @previous_on_step_count = step_delta
+      @avg_real_time = @total_real_time / (@bot.game_loop + 1)
+      @avg_step_time = @total_step_time / (@bot.game_loop + 1)
+
+      @recent_sum_time += time_delta
+      @recent_sum_steps += step_delta
+      if @recent_update_counter >= 11
+        @avg_recent_step_time = @recent_sum_time / @recent_sum_steps
+
+        @recent_sum_time = 0.0
+        @recent_sum_steps = 0
+        @recent_update_counter = 0
+      end
+      @recent_update_counter += 1
+    end
+
+    private
+
+    # @private
+    # @return [String] time with ansi colour coded
+    def format_time(time)
+      "%5.2f" % time.clamp(TRUNCATED_TIME_RANGE)
+    end
+  end
+end

data/lib/sc2ai/unit_group/action_ext.rb

@@ -7,7 +7,7 @@ module Sc2
     # Returns nil if units are empty, so use safety operator bot&.method(...)
     # @return [Sc2::Player, nil] player with active connection
     def bot
-      first&.bot
+      @bot ||= first&.bot
     end
 
     # Performs action on all units in this group

data/lib/sc2ai/unit_group/filter_ext.rb

@@ -97,6 +97,145 @@ module Sc2
       Api::UnitTypeId::ADEPT
     ].freeze
 
+    # An array of all melee units
+    # @return [Array<Integer>]
+    TYPE_MELEE = [
+      Api::UnitTypeId::SCV,
+      Api::UnitTypeId::HELLIONTANK,
+      Api::UnitTypeId::PROBE,
+      Api::UnitTypeId::DARKTEMPLAR,
+      Api::UnitTypeId::ZEALOT,
+      Api::UnitTypeId::DRONE,
+      Api::UnitTypeId::DRONEBURROWED,
+      Api::UnitTypeId::ZERGLING,
+      Api::UnitTypeId::ZERGLINGBURROWED,
+      Api::UnitTypeId::BANELING,
+      Api::UnitTypeId::BANELINGBURROWED,
+      Api::UnitTypeId::ULTRALISK,
+      Api::UnitTypeId::ULTRALISKBURROWED,
+      Api::UnitTypeId::BROODLING
+    ].freeze
+
+    # Typical units you would consider to be Ranged Units
+    # Includes: BROODLORD and CARRIER even though they spawn units
+    # and don't attack by themselves. ORACLE. and all BURROWED variants of units.
+    # Excludes strict spellcasters: MEDIVAC, RAVEN, INFESTOR, SWARMHOSTMP, DISRUPTOR
+    TYPE_RANGE = [
+      # Terran
+      Api::UnitTypeId::MARINE,
+      Api::UnitTypeId::MARAUDER,
+      Api::UnitTypeId::REAPER,
+      Api::UnitTypeId::GHOST,
+      Api::UnitTypeId::HELLION,
+      Api::UnitTypeId::WIDOWMINE,
+      Api::UnitTypeId::WIDOWMINEBURROWED,
+      Api::UnitTypeId::SIEGETANK,
+      Api::UnitTypeId::SIEGETANKSIEGED,
+      Api::UnitTypeId::CYCLONE,
+      Api::UnitTypeId::THOR,
+      Api::UnitTypeId::THORAP,
+      Api::UnitTypeId::VIKINGASSAULT,
+      Api::UnitTypeId::VIKINGFIGHTER,
+      Api::UnitTypeId::AUTOTURRET,
+      Api::UnitTypeId::BANSHEE,
+      Api::UnitTypeId::BATTLECRUISER,
+      Api::UnitTypeId::LIBERATOR,
+      Api::UnitTypeId::LIBERATORAG,
+      Api::UnitTypeId::MISSILETURRET,
+
+      # Zerg
+      Api::UnitTypeId::ROACH,
+      Api::UnitTypeId::ROACHBURROWED,
+      Api::UnitTypeId::RAVAGER,
+      Api::UnitTypeId::RAVAGERBURROWED,
+      Api::UnitTypeId::HYDRALISK,
+      Api::UnitTypeId::HYDRALISKBURROWED,
+      Api::UnitTypeId::MUTALISK,
+      Api::UnitTypeId::CORRUPTOR,
+      Api::UnitTypeId::BROODLORD,
+      Api::UnitTypeId::QUEEN,
+      Api::UnitTypeId::QUEENBURROWED,
+      Api::UnitTypeId::LURKERMP,
+      Api::UnitTypeId::LURKERMPBURROWED,
+      Api::UnitTypeId::LOCUSTMP,
+      Api::UnitTypeId::SPINECRAWLER,
+      Api::UnitTypeId::SPINECRAWLERUPROOTED,
+      Api::UnitTypeId::SPORECRAWLER,
+      Api::UnitTypeId::SPORECRAWLERUPROOTED,
+
+      # Protoss
+      Api::UnitTypeId::SENTRY,
+      Api::UnitTypeId::STALKER,
+      Api::UnitTypeId::IMMORTAL,
+      Api::UnitTypeId::ARCHON,
+      Api::UnitTypeId::HIGHTEMPLAR,
+      Api::UnitTypeId::ADEPT,
+      Api::UnitTypeId::ORACLE,
+      Api::UnitTypeId::PHOENIX,
+      Api::UnitTypeId::VOIDRAY,
+      Api::UnitTypeId::TEMPEST,
+      Api::UnitTypeId::INTERCEPTOR,
+      Api::UnitTypeId::CARRIER,
+      Api::UnitTypeId::MOTHERSHIP,
+      Api::UnitTypeId::PHOTONCANNON
+    ].freeze
+
+    # Terran: An array if infantry (Barracks) unit types
+    # @return [Array<Integer>]
+    TYPE_TERRAN_INFANTRY = [
+      Api::UnitTypeId::REAPER,
+      Api::UnitTypeId::MARINE,
+      Api::UnitTypeId::MARAUDER,
+      Api::UnitTypeId::GHOST
+    ].freeze
+
+    # Terran: An array if vehicle (Factory) unit types
+    # @return [Array<Integer>]
+    TYPE_TERRAN_VEHICLE = [
+      Api::UnitTypeId::HELLION,
+      Api::UnitTypeId::HELLIONTANK,
+      Api::UnitTypeId::WIDOWMINE,
+      Api::UnitTypeId::WIDOWMINEBURROWED,
+      Api::UnitTypeId::SIEGETANK,
+      Api::UnitTypeId::SIEGETANKSIEGED,
+      Api::UnitTypeId::THOR,
+      Api::UnitTypeId::THORAP
+    ].freeze
+
+    # Zerg: An array unit types which are Melee and benefit from Melee upgrades
+    # @return [Array<Integer>]
+    TYPE_ZERG_MELEE = [
+      Api::UnitTypeId::DRONE,
+      Api::UnitTypeId::DRONEBURROWED,
+      Api::UnitTypeId::ZERGLING,
+      Api::UnitTypeId::ZERGLINGBURROWED,
+      Api::UnitTypeId::BANELING,
+      Api::UnitTypeId::BANELINGBURROWED,
+      Api::UnitTypeId::ULTRALISK,
+      Api::UnitTypeId::ULTRALISKBURROWED,
+      Api::UnitTypeId::BROODLING
+    ].freeze
+
+    # Zerg: An array of unit types which use missile attacks and upgrades
+    # @return [Array<Integer>]
+    TYPE_ZERG_MISSILE = [
+      Api::UnitTypeId::ROACH,
+      Api::UnitTypeId::ROACHBURROWED,
+      Api::UnitTypeId::RAVAGER,
+      Api::UnitTypeId::RAVAGERBURROWED,
+      Api::UnitTypeId::HYDRALISK,
+      Api::UnitTypeId::HYDRALISKBURROWED,
+      Api::UnitTypeId::QUEEN,
+      Api::UnitTypeId::QUEENBURROWED,
+      Api::UnitTypeId::LURKERMP,
+      Api::UnitTypeId::LURKERMPBURROWED,
+      Api::UnitTypeId::LOCUSTMP,
+      Api::UnitTypeId::SPINECRAWLER,
+      Api::UnitTypeId::SPINECRAWLERUPROOTED,
+      Api::UnitTypeId::SPORECRAWLER,
+      Api::UnitTypeId::SPORECRAWLERUPROOTED
+    ].freeze
+
     # Returns a new UnitGroup containing all units matching unit type id(s)
     # Multiple values work as an "OR" filter
     # @example
@@ -105,7 +244,7 @@ module Sc2
     #   # Multiple - select space-men
     #   ug.select_type([Api::UnitTypeId::MARINE, Api::UnitTypeId::REAPER]) #=> <UnitGroup: ...>
     # @param unit_type_ids [Integer, Array<Integer>] one or an array of unit Api::UnitTypeId
-    # @return [UnitGroup]
+    # @return [Sc2::UnitGroup]
     def select_type(unit_type_ids)
       cached("#{__method__}:#{unit_type_ids.hash}") do
         if unit_type_ids.is_a? Array
@@ -123,7 +262,7 @@ module Sc2
     #   # Multiple - reject immovable army
     #   ug.reject_type([Api::UnitTypeId::SIEGETANKSIEGED, Api::UnitTypeId::WIDOWMINEBURROWED]) #=> <UnitGroup: ...>
     # @param unit_type_ids [Integer, Array<Integer>] one or an array of unit Api::UnitTypeId
-    # @return [UnitGroup]
+    # @return [Sc2::UnitGroup]
     def reject_type(unit_type_ids)
       cached("#{__method__}:#{unit_type_ids.hash}") do
         if unit_type_ids.is_a? Array
@@ -179,7 +318,7 @@ module Sc2
     #   # Multiple - select mechanical flying units
     #   ug.select_attribute([:MECHANICAL, :FLYING]) #=> <UnitGroup: ...>
     # @param attributes [Integer, Array<Integer>] one or an array of unit Api::UnitTypeId
-    # @return [UnitGroup]
+    # @return [Sc2::UnitGroup]
     def select_attribute(attributes)
       cached("#{__method__}:#{attributes.hash}") do
         attributes = [attributes] unless attributes.is_a? Array
@@ -199,7 +338,7 @@ module Sc2
     #   # Multiple - reject mechanical flying units
     #   ug.reject_attribute(:Mechanical, :Flying) #=> <UnitGroup: ...>
     # @param attributes [Integer, Array<Integer>] one or an array of unit Api::UnitTypeId
-    # @return [UnitGroup]
+    # @return [Sc2::UnitGroup]
     def reject_attribute(attributes)
       cached("#{__method__}:#{attributes.hash}") do
         attributes = [attributes] unless attributes.is_a? Array
@@ -269,7 +408,7 @@ module Sc2
     alias_method :townhalls, :bases # bad name
 
     # Selects gas structures (refinery/extractor/assimilator)
-    # @return [UnitGroup] gas structures
+    # @return [Sc2::UnitGroup] gas structures
     def gas
       select_type(TYPE_GAS_STRUCTURE)
     end
@@ -278,24 +417,25 @@ module Sc2
     alias_method :assimilators, :gas
 
     # Selects units passively have Detection
-    # @return [UnitGroup] gas structures
+    # @return [Sc2::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
+    # @return [Sc2::UnitGroup] complete unit group
     def completed
       select(&:is_completed?)
     end
 
     # Selects only units which have finished constructing, i.o.w. build_progress != 1.0
-    # @return [UnitGroup] incomplete unit group
+    # @return [Sc2::UnitGroup] incomplete unit group
     def incomplete
       reject(&:is_completed?)
     end
 
     # Selects only units which do not have orders
+    # @return [Sc2::UnitGroup]
     def idle
       select(&:is_idle?)
     end
@@ -303,13 +443,14 @@ module Sc2
     # Selects units which have this ability available
     # Queries API if necessary
     # @param [Integer] ability_id
-    # @return [UnitGroup] units which have the ability available
+    # @return [Sc2::UnitGroup] units which have the ability available
     def ability_available?(ability_id)
       select { |unit| unit.ability_available?(ability_id) }
     end
 
     # Checks whether any unit's first order matches these abilities
     # @param ability_ids [Integer, Array<Integer>] accepts one or an array of Api::AbilityId
+    # @return [Boolean]
     def is_performing_ability?(ability_ids)
       any? { |unit| unit.is_performing_ability?(ability_ids) }
     end
@@ -450,7 +591,7 @@ module Sc2
         return self if amount > @units.size
       end
 
-      if use_kdtree
+      if use_kdtree || use_kdtree.nil?
         if amount.nil?
           index = kdtree.nearest(pos.x, pos.y)
           return @units.values[index]
@@ -472,6 +613,7 @@ module Sc2
     # Selects units which are in a particular circle
     # @param point [Api::Point2D, Api::Point] center of circle
     # @param radius [Float]
+    # @return [Sc2::UnitGroup] new unit group
     def select_in_circle(point:, radius:)
       select { |unit| unit.in_circle?(point:, radius:) }
     end

data/lib/sc2ai/unit_group.rb

@@ -10,7 +10,7 @@ module Sc2
 
     # @!attribute units
     # A hash of units by tag.
-    #   @return [Hash<Integer, Api::Unit>] Api::Unit.tag => Api::Unit
+    # @return [Hash<Integer, Api::Unit>] Api::Unit.tag => Api::Unit
     attr_accessor :units
 
     # @param units [Api::Unit, Hash<Integer, Api::Unit>, Array<Api::Unit>, Sc2::UnitGroup, nil] default to be added.
@@ -177,9 +177,9 @@ module Sc2
 
     # Creates a new unit group which is the result of the two being subtracted
     # @param other_unit_group [UnitGroup]
-    # @return [UnitGroup] new unit group
+    # @return [Sc2::UnitGroup] new unit group
     def subtract(other_unit_group)
-      UnitGroup.new(@units.reject { |tag, _unit| other_unit_group.units.has_key?(tag) })
+      slice(*(tags - other_unit_group.tags))
     end
 
     alias_method :-, :subtract
@@ -237,7 +237,7 @@ module Sc2
 
     # Returns a new unit group containing each element found both in self and in all of the given other_arrays; duplicates are omitted; items are compared using eql? (items must also implement hash correctly):
     # @param other_unit_group [UnitGroup]
-    # @return [UnitGroup] new unit group
+    # @return [Sc2::UnitGroup] new unit group
     def intersection(other_unit_group)
       slice(*other_unit_group.tags)
     end

data/lib/sc2ai/version.rb

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

data/lib/sc2ai.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "logger"
+
 # In the event major runs, let it compact
 GC.auto_compact = true
 
@@ -74,12 +76,9 @@ module Sc2
     def logger
       return @logger if @logger
 
-      require "logger"
-
       @logger = Logger.new($stdout)
       @logger.level = :debug
-      @logger.datetime_format = "%H:%M:%S.%6N"
-
+      @logger.datetime_format = "%H:%M:%S.%3N"
       @logger
     end
 

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

@@ -10,5 +10,5 @@ Sc2::Match.new(
     $bot,
     Sc2::Player::Computer.new(race: Api::Race::RANDOM, difficulty: Api::Difficulty::VERY_EASY)
   ],
-  map: "ThunderbirdAIE" # Or any of the downloaded map names
+  map: "PylonAIE_v4" # Or any of the downloaded map names
 ).run