sc2ai 0.0.2 → 0.0.4

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

@@ -179,6 +179,26 @@ module Api
       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
@@ -224,6 +244,7 @@ module Api
     # Draws a placement outline
     # @param color [Api::Color] optional api color, default white
     # @return [void]
+    # noinspection RubyArgCount
     def debug_draw_placement(color = nil)
       # Slightly elevate the Z position so that the line doesn't clip into the terrain at same Z level
       z_elevated = pos.z + 0.01
@@ -432,6 +453,12 @@ module Api
       build_progress == 1.0 # standard:disable Lint/FloatComparison
     end
 
+    # Returns true if build progress is < 100%
+    # @return [Boolean]
+    def in_progress?
+      !is_completed?
+    end
+
     # Convenience functions ---
 
     # TERRAN Convenience functions ---
@@ -444,7 +471,7 @@ module Api
 
     # Returns whether the structure has a reactor add-on
     # @return [Boolean] if the unit has a reactor attached
-    def has_reactor
+    def has_reactor?
       Sc2::UnitGroup::TYPE_REACTOR.include?(add_on&.unit_type)
     end
 
@@ -455,26 +482,46 @@ module Api
     #   # Get the actual tech-lab with #add_on
     #   sp.add_on.research ...
     # @return [Boolean] if the unit has a tech lab attached
-    def has_tech_lab
+    def has_tech_lab?
       Sc2::UnitGroup::TYPE_TECHLAB.include?(add_on&.unit_type)
     end
 
     # For Terran builds a tech lab add-on on the current structure
     # @return [void]
-    def build_reactor
-      build(unit_type_id: Api::UnitTypeId::REACTOR)
+    def build_reactor(queue_command: false)
+      unit_type_id = case unit_type
+      when Api::UnitTypeId::BARRACKS, Api::UnitTypeId::BARRACKSFLYING
+        Api::UnitTypeId::BARRACKSREACTOR
+      when Api::UnitTypeId::FACTORY, Api::UnitTypeId::FACTORYFLYING
+        Api::UnitTypeId::FACTORYREACTOR
+      when Api::UnitTypeId::STARPORT, Api::UnitTypeId::STARPORTFLYING
+        Api::UnitTypeId::STARPORTREACTOR
+      end
+      build(unit_type_id: unit_type_id, queue_command:)
     end
 
     # For Terran builds a tech lab add-on on the current structure
     # @return [void]
-    def build_tech_lab
-      build(unit_type_id: Api::UnitTypeId::TECHLAB)
+    def build_tech_lab(queue_command: false)
+      unit_type_id = case unit_type
+      when Api::UnitTypeId::BARRACKS, Api::UnitTypeId::BARRACKSFLYING
+        Api::UnitTypeId::BARRACKSTECHLAB
+      when Api::UnitTypeId::FACTORY, Api::UnitTypeId::FACTORYFLYING
+        Api::UnitTypeId::FACTORYTECHLAB
+      when Api::UnitTypeId::STARPORT, Api::UnitTypeId::STARPORTFLYING
+        Api::UnitTypeId::STARPORTTECHLAB
+      end
+      build(unit_type_id: unit_type_id, queue_command:)
     end
 
+    # GENERAL Convenience functions ---
+
+    # ...
+
     private
 
     # @private
-    # Reduces repitition in the is_*action*?(target:) methods
+    # Reduces repetition in the is_*action*?(target:) methods
     def is_performing_ability_on_target?(abilities, target: nil)
       # Exit if not actioning the ability
       return false unless is_performing_ability?(abilities)

data/lib/sc2ai/unit_group/action_ext.rb

@@ -46,7 +46,7 @@ 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
 
     # Shorthand for performing action SMART (right-click)
@@ -56,11 +56,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.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
 
@@ -229,12 +234,19 @@ module Sc2
     end
 
     # 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.2"
+  VERSION = "0.0.4"
 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