sc2ai 0.0.6 → 0.0.8

data/lib/sc2ai/protocol/_meta_documentation.rb

@@ -23,8 +23,26 @@
 #     class Unit < Google::Protobuf::AbstractMessage; end;
 #     # Protobuf virtual class.
 #     class UnitTypeData < Google::Protobuf::AbstractMessage; end;
+#     # Protobuf virtual class.
+#     class AvailableAbility < Google::Protobuf::AbstractMessage; end;
+#     # Protobuf virtual class.
+#     class UnitOrder < Google::Protobuf::AbstractMessage; end;
+#     # Protobuf virtual class.
+#     class ActionRawUnitCommand < Google::Protobuf::AbstractMessage; end;
+#     # Protobuf virtual class.
+#     class ActionRawToggleAutocast < Google::Protobuf::AbstractMessage; end;
+#     # Protobuf virtual class.
+#     class ActionError < Google::Protobuf::AbstractMessage; end;
+#     # Protobuf virtual class.
+#     class ActionSpatialUnitCommand < Google::Protobuf::AbstractMessage; end;
+#     # Protobuf virtual class.
+#     class BuildItem < Google::Protobuf::AbstractMessage; end;
+#     # Protobuf virtual class.
+#     class ActionToggleAutocast < Google::Protobuf::AbstractMessage; end;
 #   end
 
+
+
 # Protobuf enums ---
 # Protobuf classes
 # @!parse

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

@@ -12,7 +12,7 @@ module Api
 
     # Create a new 3d Point, by adding a y axis.
     # @return [Api::Point]
-    def to_3d(z:)
+    def to_3d(z: 0)
       Api::Point[x, y, z]
     end
 

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

@@ -0,0 +1,11 @@
+# This class was partially generated with the help of AI.
+
+module Api
+  # Adds additional functionality to message object Api::Unit
+  module PointDistanceExtension
+  end
+end
+Api::Point.include Api::PointDistanceExtension
+Api::Point2D.include Api::PointDistanceExtension
+Api::PointI.include Api::PointDistanceExtension
+Api::Size2DI.include Api::PointDistanceExtension

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

@@ -84,7 +84,6 @@ module Sc2
       # raise NoMethodError unless location == self
 
       # Perf: Memoizing attributes which are hit hard, show gain
-
       @y ||= send(:method_missing, :y)
     end
 
@@ -97,9 +96,9 @@ module Sc2
 
     # 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
@@ -112,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

@@ -227,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
 
@@ -241,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)
@@ -263,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:)
@@ -359,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
@@ -421,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]
@@ -546,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,14 +231,28 @@ 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 { |unit| unit.orders.empty? }
+      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 ------------------------------------------
@@ -340,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/version.rb

@@ -2,5 +2,5 @@
 
 module Sc2
   # gem version
-  VERSION = "0.0.6"
+  VERSION = "0.0.8"
 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