sc2ai 0.0.5 → 0.0.7

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

@@ -1,12 +1,23 @@
 module Sc2
   # A unified construct that tames Api::* messages which contain location data
-  # Items which are of type Sc2::Location will have #x and #y property at the least.
+  # Items which are of type Sc2::Position will have #x and #y property at the least.
   module Position
     # Tolerance for floating-point comparisons.
     TOLERANCE = 1e-9
 
     # Basic operations
 
+    # Loose equality matches on floats x and y.
+    # We never check z-axis, because the map is single-level.
+    # TODO: We should almost certainly introduce TOLERANCE here, but verify it's cost first.
+    def ==(other)
+      if other.is_a? Position
+        x == other.x && y == other.y
+      else
+        false
+      end
+    end
+
     # A new point representing the sum of this point and the other point.
     # @param other [Api::Point2D, Numeric] The other point/number to add.
     # @return [Api::Point2D]
@@ -50,19 +61,44 @@ module Sc2
     # @see #divide
     alias_method :/, :divide
 
-    # Bug: Psych implements method 'y' on Kernel, but protobuf uses method_missing to read AbstractMethod
-    # We send method missing ourselves when y to fix this chain.
+    # Returns x coordinate
+    # @return [Float]
+    def x
+      # Perf: Memoizing attributes which are hit hard, show gain
+      @x ||= send(:method_missing, :x)
+    end
+
+    # Sets x coordinate
+    # @return [Float]
+    def x=(x)
+      send(:method_missing, :x=, x)
+      @x = x
+    end
+
+    # Returns y coordinate
+    # @return [Float]
     def y
+      # Bug: Psych implements method 'y' on Kernel, but protobuf uses method_missing to read AbstractMethod
+      # We send method missing ourselves when y to fix this chain.
       # This is correct, but an unnecessary conditional:
       # raise NoMethodError unless location == self
-      send(:method_missing, :y)
+
+      # Perf: Memoizing attributes which are hit hard, show gain
+      @y ||= send(:method_missing, :y)
+    end
+
+    # Sets y coordinate
+    # @return [Float]
+    def y=(y)
+      send(:method_missing, :y=, y)
+      @y = y
     end
 
     # Randomly adjusts both x and y by a range of: -offset..offset
     # @param offset [Float]
-    # @return [Api::Point2D]
+    # @return [Sc2::Position] new Position
     def random_offset(offset)
-      Api::Point2D.new[x, y].random_offset!(offset)
+      dup.random_offset!(offset)
     end
 
     # Changes this point's x and y by the supplied offset
@@ -75,17 +111,16 @@ module Sc2
     end
 
     # Creates a new point with x and y which is offset
-    # @return [Api::Point2D] self
-    def offset(x, y)
-      Api::Point2D.new[x, y].offset!(x, y)
-      self
+    # @return [Sc2::Position] new Position
+    def offset(x = 0, y = 0)
+      dup.offset!(x, y)
     end
 
     # Changes this point's x and y by the supplied offset
     # @return [Sc2::Position] self
-    def offset!(x, y)
-      self.x -= x
-      self.y -= y
+    def offset!(x = 0, y = 0)
+      self.x += x
+      self.y += y
       self
     end
 

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

@@ -9,6 +9,22 @@ module Api
       tag || super
     end
 
+    # Returns an integer unique identifier
+    # If the unit goes out of vision and is snapshot-able, they get a random id
+    # - Such a unit gets the same unit tag when it re-enters vision
+    # @return [Integer]
+    def tag
+      # Perf: This speeds up hash and therefore common UnitGroup operations. Sometimes 3x!
+      @tag ||= send(:method_missing, :tag)
+    end
+
+    # Sets unit tag
+    # @return [Integer]
+    def tag=(tag)
+      send(:method_missing, :tag=, tag)
+      @tag = tag
+    end
+
     # Every unit gets access back to the bot to allow api access.
     # For your own units, this allows API access.
     # @return [Sc2::Player] player with active connection
@@ -161,6 +177,15 @@ module Api
 
     # @!endgroup Virtual properties
 
+    # Whether unit is effected by buff_id
+    # @example
+    #   unit.has_buff??(Api::BuffId::QUEENSPAWNLARVATIMER)
+    # @param [Integer] buff_id
+    # @return [Boolean]
+    def has_buff?(buff_id)
+      buff_ids.include?(buff_id)
+    end
+
     # @!group Actions
 
     # Performs action on this unit
@@ -202,6 +227,7 @@ module Api
     # @param target [Api::Unit, Integer, Api::Point2D] is a unit, unit tag or a Api::Point2D
     # @param queue_command [Boolean] shift+command
     def attack(target:, queue_command: false)
+      return false if target.nil?
       action(ability_id: Api::AbilityId::ATTACK, target:, queue_command:)
     end
 
@@ -216,7 +242,7 @@ module Api
     end
 
     # Builds target unit type, i.e. issuing a build command to worker.build(...Api::UnitTypeId::BARRACKS)
-    # @param unit_type_id [Integer] Api::UnitTypeId the unit type which will do the creation
+    # @param unit_type_id [Integer] Api::UnitTypeId the unit type you wish to build
     # @param target [Api::Point2D, Integer, nil] is a unit tag or a Api::Point2D. Nil for addons/orbital
     # @param queue_command [Boolean] shift+command
     def build(unit_type_id:, target: nil, queue_command: false)
@@ -238,7 +264,7 @@ module Api
     end
 
     # Research a specific upgrade
-    # @param upgrade_id [Integer] Api::UnitTypeId the unit type which will do the creation
+    # @param upgrade_id [Integer] Api::UnitTypeId the unit type you wish to research
     # @param queue_command [Boolean] shift+command
     def research(upgrade_id:, queue_command: false)
       @bot.research(units: self, upgrade_id:, queue_command:)
@@ -334,7 +360,7 @@ module Api
     # @param target [Api::Unit, Integer] optionally check if unit is engaged with specific target
     def is_attacking?(target: nil)
       is_performing_ability_on_target?(
-        [Api::AbilityId::ATTACK_ATTACK],
+        [Api::AbilityId::ATTACK_ATTACK, Api::AbilityId::ATTACK],
         target:
       )
     end
@@ -396,6 +422,14 @@ module Api
       end
     end
 
+    # Returns whether this unit has an ability available
+    # Queries API if necessary
+    # @param [Integer] ability_id
+    # @return [Boolean]
+    def ability_available?(ability_id)
+      @bot.unit_ability_available?(unit_tag: tag, ability_id:)
+    end
+
     # Checks whether a weapon can target a unit
     # @param unit [Api::unit]
     # @param weapon [Api::Weapon]
@@ -521,8 +555,25 @@ module Api
       build(unit_type_id: unit_type_id, queue_command:)
     end
 
+    # PROTOSS Convenience functions ---
+
+    # Warps in unit type at target (location or pylon)
+    # Only works if the source is a Warp Gate
+    # @param unit_type_id [Integer] Api::UnitTypeId the unit type you wish to build
+    # @param target [Api::Point2D] a point, which should be inside an energy source
+    # @param queue_command [Boolean] shift+command
+    def warp(unit_type_id:, target:, queue_command: false)
+      @bot.warp(units: self, unit_type_id:, target:, queue_command:)
+    end
+
     # GENERAL Convenience functions ---
 
+    # Returns true if unit does not have orders
+    # @return [Boolean] whether unit is idle
+    def is_idle?
+      orders.empty?
+    end
+
     # ...
 
     private

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

@@ -0,0 +1,9 @@
+module Api
+  # Adds additional functionality to message object Api::Unit
+  module UnitTypeExtension
+    def mood
+      "Crafty"
+    end
+  end
+end
+Api::UnitTypeData.prepend Api::UnitTypeExtension

data/lib/sc2ai/unit_group/action_ext.rb

@@ -26,7 +26,7 @@ module Sc2
     end
 
     # Builds target unit type, i.e. issuing a build command to worker.build(...Api::UnitTypeId::BARRACKS)
-    # @param unit_type_id [Integer] Api::UnitTypeId the unit type which will do the creation
+    # @param unit_type_id [Integer] Api::UnitTypeId the unit type you wish to build
     # @param target [Api::Point2D, Integer, nil] is a unit tag or a Api::Point2D. Nil for addons/orbital
     # @param queue_command [Boolean] shift+command
     def build(unit_type_id:, target: nil, queue_command: false)
@@ -41,10 +41,10 @@ module Sc2
 
     # Warps in unit type at target (location or pylon)
     # Will only have affect is this group consists of warp gates, i.e. bot.structures.warpgates
-    # @param unit_type_id [Integer] Api::UnitTypeId the unit type which will do the creation
+    # @param unit_type_id [Integer] Api::UnitTypeId the unit type you wish to build
     # @param target [Api::Point2D] a point, which should be inside an energy source
     # @param queue_command [Boolean] shift+command
-    def warp(unit_type_id:, target: nil, queue_command: false)
+    def warp(unit_type_id:, target:, queue_command: false)
       return if size.zero?
       bot&.warp(units: self, unit_type_id:, target:, queue_command:)
     end

data/lib/sc2ai/unit_group/filter_ext.rb

@@ -121,13 +121,14 @@ module Sc2
 
       # @private
       # Does the opposite of selector and returns those values for parent
-      def select_type(*)
-        @parent.reject_type(*)
+      def select(...)
+        @parent.reject(...)
       end
 
+      # @private
       # Does the opposite of selector and returns those values for parent
-      def reject_type(*)
-        @parent.select_type(*)
+      def reject(...)
+        @parent.select(...)
       end
     end
 
@@ -230,11 +231,30 @@ module Sc2
     alias_method :assimilators, :gas
 
     # Selects only units which have finished constructing, i.o.w. build_progress == 1.0
-    # @return [UnitGroup] gas structures
+    # @return [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
+    def incomplete
+      reject(&:is_completed?)
+    end
+
+    # Selects only units which do not have orders
+    def idle
+      select(&:is_idle?)
+    end
+
+    # Selects units which have this ability available\
+    # Queries API if necessary
+    # @param [Integer] ability_id
+    # @return [UnitGroup] units which have the ability available
+    def ability_available?(ability_id)
+      select { |unit| unit.ability_available?(ability_id) }
+    end
+
     # NEUTRAL ------------------------------------------
 
     # Selects mineral fields
@@ -290,7 +310,13 @@ module Sc2
     # Selects overlords
     # @return [Sc2::UnitGroup]
     def overlords
-      select_type([Api::UnitTypeId::OVERLORD, Api::UnitTypeId::OVERLORDCOCOON])
+      select_type([Api::UnitTypeId::OVERLORD, Api::UnitTypeId::OVERLORDTRANSPORT, Api::UnitTypeId::TRANSPORTOVERLORDCOCOON])
+    end
+
+    # Selects overseers
+    # @return [Sc2::UnitGroup]
+    def overseers
+      select_type([Api::UnitTypeId::OVERLORDCOCOON, Api::UnitTypeId::OVERSEER, Api::UnitTypeId::OVERSEERSIEGEMODE])
     end
 
     # Selects creep tumors (all)
@@ -329,7 +355,7 @@ module Sc2
     # Selects pylons and warp prisms in phasing mode
     # @return [Sc2::UnitGroup] pylons annd warp prisms phasing
     def warpables
-      select_type([Api::UnitTypeId::PYLON, Api::UnitTypeId::WARPPRISMPHASING])
+      select_type([Api::UnitTypeId::PYLON, Api::UnitTypeId::WARPPRISMPHASING]).completed
     end
 
     # Geometric/Map ---

data/lib/sc2ai/unit_group/geo_ext.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "sc2ai/unit_group"
+
+module Sc2
+  # A set geometric/map/math methods for unit group
+  class UnitGroup
+    # Returns the center (average) position of all units or nil if the group is empty.
+    # Outliers effect this point
+    # @return [Api::Point2D, nil]
+    def pos_centroid
+      return nil if size == 0
+      size = @units.size
+      sum_x = 0.0
+      sum_y = 0.0
+      i = 0
+
+      while i < size
+        unit = at(i)
+        sum_x += unit.pos.x.to_f
+        sum_y += unit.pos.y.to_f
+        i += 1
+      end
+
+      Api::Point2D[sum_x / size.to_f, sum_y / size.to_f]
+    end
+  end
+end

data/lib/sc2ai/unit_group.rb

@@ -182,6 +182,8 @@ module Sc2
       UnitGroup.new(@units.reject { |tag, _unit| other_unit_group.units.has_key?(tag) })
     end
 
+    alias_method :-, :subtract
+
     # Merges unit_group with our units and returns a new unit group
     # @return [Sc2::UnitGroup] a new unit group with items merged
     def merge(unit_group)
@@ -295,3 +297,4 @@ end
 
 require_relative "unit_group/action_ext"
 require_relative "unit_group/filter_ext"
+require_relative "unit_group/geo_ext"

data/lib/sc2ai/version.rb

@@ -2,5 +2,5 @@
 
 module Sc2
   # gem version
-  VERSION = "0.0.5"
+  VERSION = "0.0.7"
 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::VeryEasy)
   ],
-  map: "Goldenaura512V2AIE" # Or any of the downloaded map names
+  map: "GoldenAura513AIE" # Or any of the downloaded map names
 ).run