sc2ai 0.0.3 → 0.0.5

data/lib/sc2ai/unit_group/action_ext.rb

@@ -46,7 +46,16 @@ module Sc2
     # @param queue_command [Boolean] shift+command
     def warp(unit_type_id:, target: nil, queue_command: false)
       return if size.zero?
-      bot&.warp(units: self, unit_type_id:, target: target, queue_command:)
+      bot&.warp(units: self, unit_type_id:, target:, queue_command:)
+    end
+
+    # Research a specific upgrade at one of these structures
+    # @param upgrade_id [Integer] Api::UpgradeId to research
+    # @param queue_command [Boolean] shift+command
+    def research(upgrade_id:, queue_command: false)
+      return if size.zero?
+
+      bot&.research(units: self, upgrade_id:, queue_command:)
     end
 
     # Shorthand for performing action SMART (right-click)
@@ -56,11 +65,31 @@ module Sc2
       action(ability_id: Api::AbilityId::SMART, target:, queue_command:)
     end
 
+    # Shorthand for performing action MOVE
+    # @param target [Api::Unit, Integer, Api::Point2D] is a unit, unit tag or a Api::Point2D
+    # @param queue_command [Boolean] shift+command
+    def move(target:, queue_command: false)
+      action(ability_id: Api::AbilityId::MOVE, target:, queue_command:)
+    end
+
+    # Shorthand for performing action STOP
+    # @param queue_command [Boolean] shift+command
+    def stop(queue_command: false)
+      action(ability_id: Api::AbilityId::STOP, queue_command:)
+    end
+
+    # Shorthand for performing action HOLDPOSITION
+    # @param queue_command [Boolean] shift+command
+    def hold(queue_command: false)
+      action(ability_id: Api::AbilityId::HOLDPOSITION, queue_command:)
+    end
+    alias_method :hold_position, :hold
+
     # Shorthand for performing action ATTACK
     # @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)
-      action(ability_id: Api::AbilityId::ATTACK, target: target, queue_command: queue_command)
+      action(ability_id: Api::AbilityId::ATTACK, target:, queue_command:)
     end
 
     # Issues repair command on target

data/lib/sc2ai/unit_group/filter_ext.rb

@@ -229,6 +229,12 @@ module Sc2
     alias_method :extractors, :gas
     alias_method :assimilators, :gas
 
+    # Selects only units which have finished constructing, i.o.w. build_progress == 1.0
+    # @return [UnitGroup] gas structures
+    def completed
+      select(&:is_completed?)
+    end
+
     # NEUTRAL ------------------------------------------
 
     # Selects mineral fields

data/lib/sc2ai/unit_group.rb

@@ -89,27 +89,32 @@ module Sc2
       @units[tags.at(index)]
     end
 
+    # Meta documentation methods
+    # @!method first
+    #   @return [Api::Unit]
+    # @!method last
+    #   @return [Api::Unit]
+
     # Calls the given block with each Api::Unit value
     # @example
-    #   unit_group.each {|unit| puts unit.tag } #=> 1234 ...
-    #
     #   unit_group.each do |unit|
     #      puts unit.tag #=> 1234 ...
     #   end
-    def each(&block)
-      @units.each_value(&block)
+    # @yieldparam unit [Api::Unit]
+    def each(&)
+      @units.each_value(&)
     end
 
     # Calls the given block with each key-value pair
     # @return [self] a new unit group with items merged
     # @example
-    #   unit_group.each {|tag, unit| puts "#{tag}: #{unit}"} #=> "12345: #<Api::Unit ...>"
-    #
-    #   unit_group.each do |tag, unit|
+    #   unit_group.each_with_tag do |tag, unit|
     #      puts "#{tag}: #{unit}"} #=> "12345: #<Api::Unit ...>"
     #   end
-    def each_with_tag(&block)
-      @units.each(&block)
+    # @yieldparam tag [Integer]
+    # @yieldparam unit [Api::Unit]
+    def each_with_tag(&)
+      @units.each(&)
       self
     end
 
@@ -222,19 +227,34 @@ module Sc2
       UnitGroup.new(@units.except(...))
     end
 
-    # Returns a hash containing the entries for given tag(s).
+    # Returns a new unit group containing the entries for given tag(s).
     # @return [Sc2::UnitGroup] new unit group
     def slice(...)
       UnitGroup.new(@units.slice(...))
     end
 
+    # 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
+    def intersection(other_unit_group)
+      slice(*other_unit_group.tags)
+    end
+    alias_method :&, :intersection
+
     # Selects a single random Unit without a parameter or an array of Units with a param, i.e. self.random(2)
-    # @return []
+    # @return [Api::Unit]
     def sample(...)
       @units.values.sample(...)
     end
     alias_method :random, :sample
 
+    # Returns the first Unit for which the block returns a truthy value
+    # @return [Api::Unit]
+    def detect(...)
+      @units.values.find(...)
+    end
+    alias_method :find, :detect
+
     # def select_or(*procs)
     #   result = UnitGroup.new
     #   procs.each do |proc|

data/lib/sc2ai/version.rb

@@ -2,5 +2,5 @@
 
 module Sc2
   # gem version
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

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

@@ -4,14 +4,13 @@ class <%= @classname %> < Sc2::Player::Bot
 
   def configure
     @realtime = false # Step-mode vs Bot, Realtime vs Humans
-    @step_size = 1 # Gives 22.4ms, typically compete at 2 (44.8ms) or 4 (179.2ms).
+    @step_count = 2 # 2s/22.4 = ~89.29ms step cycle time allowance
     @enable_feature_layer = false; # Enables ui_ and spatial_ actions. Advanced, and has performance cost.
   end
 
   def on_step
     if game_loop == 0
-      enemy_start_pos = game_info.start_raw.start_locations.first
-      units.workers.attack(target: enemy_start_pos)
+      units.workers.attack(target: geo.enemy_start_position)
     end
 
     # If your attack fails, "good game" and exit

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