sc2ai 0.7.0 → 0.8.0

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.7.0"
+  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: "PylonAIE" # Or any of the downloaded map names
+  map: "PylonAIE_v4" # Or any of the downloaded map names
 ).run