sc2ai 0.1.0 → 0.3.0

data/lib/sc2ai/player.rb

@@ -21,10 +21,10 @@ module Sc2
     extend Forwardable
     def_delegators :@api, :add_listener
 
-    # Known races for detecting race on Api::Race::Random or nil
+    # Known races for detecting race on Api::Race::RANDOM or nil
     # @!attribute IDENTIFIED_RACES
-    #   @return [Array<Integer>]
-    IDENTIFIED_RACES = [Api::Race::Protoss, Api::Race::Terran, Api::Race::Zerg].freeze
+    # @return [Array<Integer>]
+    IDENTIFIED_RACES = [Api::Race::PROTOSS, Api::Race::TERRAN, Api::Race::ZERG].freeze
 
     # @!attribute api
     #   Manages connection to client and performs Requests
@@ -51,27 +51,22 @@ module Sc2
     # @return [Hash]
     attr_accessor :interface_options
 
-    # @return [Api::Race::NoRace] if Observer
-    # @return [Api::Race::Terran] if is_a? Bot, Human, BotProcess
-    # @return [Api::Race::Zerg] if is_a? Bot, Human, BotProcess
-    # @return [Api::Race::Protoss] if is_a? Bot, Human, BotProcess
-    # @return [Api::Race::Random] if specified random and in-game race hasn't been scouted yet
-    # @return [nil] if is_a? forgetful person
+    # @return [Integer] Api::Race enum
     attr_accessor :race
 
     # @return [String] in-game name
     attr_accessor :name
 
-    # @return [Api::PlayerType::Participant, Api::PlayerType::Computer, Api::PlayerType::Observer] PlayerType
+    # @return [Integer] Api::PlayerType::PARTICIPANT, Api::PlayerType::COMPUTER, Api::PlayerType::OBSERVER
     attr_accessor :type
 
-    # if @type is Api::PlayerType::Computer, set one of Api::Difficulty scale 1 to 10
+    # if @type is Api::PlayerType::COMPUTER, set one of Api::Difficulty scale 1 to 10
     # @see Api::Difficulty for options
-    # @return [Api::Difficulty::VeryEasy] if easiest, int 1
-    # @return [Api::Difficulty::CheatInsane] if toughest, int 10
+    # @return [Integer]
     attr_accessor :difficulty
 
     # @see Api::AIBuild proto for options
+    # @return [Integer]
     attr_accessor :ai_build
 
     # @return [String] ladder matches will set an opponent id
@@ -153,7 +148,7 @@ module Sc2
     def join_game(server_host:, port_config:)
       Sc2.logger.debug { "Player \"#{@name}\" joining game..." }
       response = @api.join_game(name: @name, race: @race, server_host:, port_config:, enable_feature_layer: @enable_feature_layer, interface_options: @interface_options)
-      if !response.error.nil? && response.error != :MissingParticipation
+      if response.error != :ENUM_RESPONSE_JOIN_GAME_ERROR_UNSET && response.error != :MISSING_PARTICIPATION
         raise Sc2::Error, "Player \"#{@name}\" join_game failed: #{response.error}"
       end
       add_listener(self, klass: Connection::StatusListener)
@@ -172,7 +167,7 @@ module Sc2
     # Bot
     # race != None
     # name=''
-    # type: Api::PlayerType::Participant
+    # type: Api::PlayerType::PARTICIPANT
 
     # An object which interacts with an SC2 client and is game-aware.
     class Bot < Player
@@ -193,7 +188,7 @@ module Sc2
       attr_accessor :geo
 
       def initialize(race:, name:)
-        super(race:, name:, type: Api::PlayerType::Participant, difficulty: nil, ai_build: nil)
+        super(race:, name:, type: Api::PlayerType::PARTICIPANT, difficulty: nil, ai_build: nil)
         @previous = Sc2::Player::PreviousState.new
         @geo = Sc2::Player::Geo.new(self)
 
@@ -211,11 +206,12 @@ module Sc2
       #   end
       def configure
       end
+
       alias_method :before_join, :configure
 
       # TODO: If this suffices for Bot and Observer, they should share this code.
       # Initializes and refreshes game data and runs the game loop
-      # @return [Api::Result::Victory, Api::Result::Defeat, Api::Result::Tie, Api::Result::Undecided] result
+      # @return [Integer] One of Api::Result::VICTORY, Api::Result::DEFEAT, Api::Result::TIE, Api::Result::UNDECIDED
       def play
         # Step 0
         prepare_start
@@ -227,16 +223,45 @@ module Sc2
         # Callback for step 0
         on_step
 
+        # Local play prints out avg times
+        unless Sc2.ladder?
+          running_avg_step_times = []
+          average_runtime = 0.0
+        end
+
         puts ""
+
         # Step 1 to n
+        i = 0
         loop do
+          if i >= 5
+            i = 0
+          end
           r = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
           perform_actions
           perform_debug_commands unless Sc2.ladder?
           step_forward
-          print "\e[2K#{game_loop - @previous.game_loop} Steps Took (ms): #{(::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - r) * 1000}\n\e[1A\r"
+
+          unless Sc2.ladder?
+            time_delta = (::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - r) * 1000
+            step_delta = game_loop - @previous.game_loop
+            # running_avg_step_times.shift if running_avg_step_times.size == 5
+            running_avg_step_times << [time_delta, step_delta]
+
+            if i == 0
+              sum_t, sum_s = running_avg_step_times.each_with_object([0, 0]) do |n, total|
+                total[0] += n[0]
+                total[1] += n[1]
+              end
+              average_runtime = sum_t / sum_s
+              running_avg_step_times.clear
+            end
+            print "\e[2K#{step_delta} Step(s) Took (ms): #{"%.2f" % time_delta} | Avg (ms/frame): #{"%.2f" % average_runtime}\n\e[1A\r"
+          end
+
+          i += 1
           return @result unless @result.nil?
-          break if @status != :in_game
+          break if @status != :IN_GAME
         end
       end
 
@@ -261,11 +286,11 @@ module Sc2
       # Callbacks ---
 
       # Override to handle game result (:Victory/:Loss/:Tie)
-      # Called when game has ended with a result, i.e. result = ::Victory
-      # @param result [Symbol] Api::Result::Victory or Api::Result::Victory::Defeat or Api::Result::Victory::Undecided
+      # Called when game has ended with a result, i.e. result = :Victory
+      # @param result [Symbol] Api::Result::VICTORY or Api::Result::DEFEAT or Api::Result::UNDECIDED
       # @example
       #   def on_finish(result)
-      #     if result == :Victory
+      #     if result == :VICTORY
       #       puts "Yay!"
       #     else
       #       puts "Lets try again!"
@@ -277,7 +302,7 @@ module Sc2
 
       # Called when Random race is first detected.
       # Override to handle race identification of random enemy.
-      # @param race [Integer] Api::Race::* excl *::Random
+      # @param race [Integer] see {Api::Race}
       def on_random_race_detected(race)
       end
 
@@ -301,9 +326,9 @@ module Sc2
       # @example
       #   alerts.each do |alert|
       #     case alert
-      #     when :NuclearLaunchDetected
+      #     when :NUCLEAR_LAUNCH_DETECTED
       #       pp "TAKE COVER!"
-      #     when :NydusWormDetected
+      #     when :NYDUS_WORM_DETECTED
       #       pp "FIND THE WORM!"
       #     end
       #   end
@@ -423,26 +448,26 @@ module Sc2
     # Allows using CLI launch options hash or "laddorconfig.json"-complient launcher.
     class BotProcess < Player
       def initialize(race:, name:)
-        super(race:, name:, type: Api::PlayerType::Participant)
+        super(race:, name:, type: Api::PlayerType::PARTICIPANT)
         raise "not implemented"
       end
     end
 
     # A Computer opponent using the game's built-in AI for a Match
     class Computer < Player
-      # @param race [Integer] (see Api::Race)
-      # @param difficulty [Integer] see Api::Difficulty::VeryEasy,Api::Difficulty::VeryHard,etc.)
-      # @param ai_build [Api::AIBuild::RandomBuild] (see Api::AIBuild)
+      # @param race [Integer] see {Api::Race}
+      # @param difficulty [Integer] Api::Difficulty::VERY_EASY, Api::Difficulty::VERY_HARD,etc.
+      # @param ai_build [Integer] default: Api::AIBuild::RANDOM_BUILD
       # @param name [String]
       # @return [Sc2::Computer]
-      def initialize(race:, difficulty: Api::Difficulty::VeryEasy, ai_build: Api::AIBuild::RandomBuild,
+      def initialize(race:, difficulty: Api::Difficulty::VERY_EASY, ai_build: Api::AIBuild::RANDOM_BUILD,
         name: "Computer")
-        difficulty = Api::Difficulty::VeryEasy if difficulty.nil?
-        ai_build = Api::AIBuild::RandomBuild if ai_build.nil?
+        difficulty = Api::Difficulty::VERY_EASY if difficulty.nil?
+        ai_build = Api::AIBuild::RANDOM_BUILD if ai_build.nil?
         raise Error, "unknown difficulty: '#{difficulty}'" if Api::Difficulty.lookup(difficulty).nil?
         raise Error, "unknown difficulty: '#{ai_build}'" if Api::AIBuild.lookup(ai_build).nil?
 
-        super(race:, name:, type: Api::PlayerType::Computer, difficulty:, ai_build:)
+        super(race:, name:, type: Api::PlayerType::COMPUTER, difficulty:, ai_build:)
       end
 
       # Returns whether or not the player requires a sc2 instance
@@ -460,14 +485,14 @@ module Sc2
     # A human player for a Match
     class Human < Player
       def initialize(race:, name:)
-        super(race:, name:, type: Api::PlayerType::Participant)
+        super(race:, name:, type: Api::PlayerType::PARTICIPANT)
       end
     end
 
     # A spectator for a Match
     class Observer < Player
       def initialize(name: nil)
-        super(race: Api::Race::NoRace, name:, type: Api::PlayerType::Observer)
+        super(race: Api::Race::NO_RACE, name:, type: Api::PlayerType::OBSERVER)
       end
     end
 
@@ -481,6 +506,29 @@ module Sc2
 
     private
 
+    # @private
+    CALLBACK_METHODS = %i[on_finish
+      on_random_race_detected
+      on_action_errors
+      on_actions_performed
+      on_alerts
+      on_upgrades_completed
+      on_parse_observation_unit
+      on_unit_destroyed
+      on_unit_created
+      on_unit_type_changed
+      on_structure_started
+      on_structure_completed
+      on_unit_damaged]
+
+    # @private
+    # Checks if callback method is defined on our bot
+    # Used to skip processing on unused callbacks
+    # @param callback [Symbol]
+    def callback_defined?(callback)
+      CALLBACK_METHODS.include?(callback)
+    end
+
     # Initialize data on step 0 before stepping and before on_start is called
     def prepare_start
       @data = Sc2::Data.new(@api.data)
@@ -525,6 +573,10 @@ module Sc2
 
       # Save previous frame before continuing
       @previous.reset(self)
+
+      # We can request game info async, while we process observation
+      refresh_game_info
+
       # Reset
       self.observation = response_observation.observation
       self.game_loop = observation.game_loop
@@ -532,17 +584,14 @@ module Sc2
       self.spent_minerals = 0
       self.spent_vespene = 0
       self.spent_supply = 0
-      # Geometric/map
-      if observation.raw_data.map_state.visibility != previous.observation&.raw_data&.map_state&.visibility
-        @parsed_visibility_grid = nil
-      end
+      geo.reset
 
-      # Only grab game_info if unset (loop 0 or first realtime loop). It's lazily loaded otherwise as needed
-      # This is heavy processing, because it contains image data
-      if game_info.nil?
-        refresh_game_info
+      # First game-loop: set enemy and our race if random
+      if enemy.nil?
+        # Finish game_info load immediately, because we need it's info
+        game_info
         set_enemy
-        set_race_for_random if race == Api::Race::Random
+        set_race_for_random if race == Api::Race::RANDOM
       end
 
       parse_observation_units(response_observation.observation)
@@ -554,7 +603,12 @@ module Sc2
 
       # Actions performed and errors (only if implemented)
       on_actions_performed(response_observation.actions) unless response_observation.actions.empty?
-      on_action_errors(response_observation.action_errors) unless response_observation.action_errors.empty?
+      if callback_defined?(:on_action_errors)
+        unless response_observation.action_errors.empty?
+          @action_errors.concat(response_observation.action_errors.to_a)
+        end
+        on_action_errors(@action_errors) unless @action_errors&.empty?
+      end
       on_alerts(observation.alerts) unless observation.alerts.empty?
 
       # Diff previous observation upgrades to see if anything new completed
@@ -583,7 +637,10 @@ module Sc2
     # Refreshes bot#game_info ignoring all caches
     # @return [void]
     public def refresh_game_info
-      self.game_info = @api.game_info
+      @game_info_task = Async do
+        self.game_info = @api.game_info
+        @game_info_task = nil
+      end
     end
 
     # Enemy -----------------------
@@ -600,7 +657,7 @@ module Sc2
       self.enemy = Sc2::Player::Enemy.from_proto(player_info: enemy_player_info)
 
       if enemy.nil?
-        self.enemy = Sc2::Player::Enemy.new(name: "Unknown", race: Api::Race::Random)
+        self.enemy = Sc2::Player::Enemy.new(name: "Unknown", race: Api::Race::RANDOM)
       end
       if enemy.race_unknown?
         detected_race = enemy.detect_race_from_units

data/lib/sc2ai/ports.rb

@@ -124,7 +124,6 @@ module Sc2
       ensure
         # noinspection RubyScope
         socket&.close
-        false
       end
     end
   end
@@ -136,7 +135,7 @@ module Sc2
     def initialize(start_port:, num_players:, ports: [])
       @start_port = start_port
       @server_port_set = nil
-      @client_port_sets = nil
+      @client_port_sets = []
       return if num_players <= 1
 
       return if ports.empty?

data/lib/sc2ai/protocol/_meta_documentation.rb

@@ -6,39 +6,39 @@
 # @!parse
 #   module Api;
 #     # Protobuf virtual class.
-#     class Color < Google::Protobuf::AbstractMessage; end;
+#     class Color end;
 #     # Protobuf virtual class.
-#     class Point < Google::Protobuf::AbstractMessage; end;
+#     class Point end;
 #     # Protobuf virtual class.
-#     class Point2D < Google::Protobuf::AbstractMessage; end;
+#     class Point2D end;
 #     # Protobuf virtual class.
-#     class PointI < Google::Protobuf::AbstractMessage; end;
+#     class PointI end;
 #     # Protobuf virtual class.
-#     class PowerSource < Google::Protobuf::AbstractMessage; end;
+#     class PowerSource end;
 #     # Protobuf virtual class.
-#     class Size2DI < Google::Protobuf::AbstractMessage; end;
+#     class Size2DI end;
 #     # Protobuf virtual class.
-#     class Point < Google::Protobuf::AbstractMessage; end;
+#     class Point end;
 #     # Protobuf virtual class.
-#     class Unit < Google::Protobuf::AbstractMessage; end;
+#     class Unit end;
 #     # Protobuf virtual class.
-#     class UnitTypeData < Google::Protobuf::AbstractMessage; end;
+#     class UnitTypeData end;
 #     # Protobuf virtual class.
-#     class AvailableAbility < Google::Protobuf::AbstractMessage; end;
+#     class AvailableAbility end;
 #     # Protobuf virtual class.
-#     class UnitOrder < Google::Protobuf::AbstractMessage; end;
+#     class UnitOrder end;
 #     # Protobuf virtual class.
-#     class ActionRawUnitCommand < Google::Protobuf::AbstractMessage; end;
+#     class ActionRawUnitCommand end;
 #     # Protobuf virtual class.
-#     class ActionRawToggleAutocast < Google::Protobuf::AbstractMessage; end;
+#     class ActionRawToggleAutocast end;
 #     # Protobuf virtual class.
-#     class ActionError < Google::Protobuf::AbstractMessage; end;
+#     class ActionError end;
 #     # Protobuf virtual class.
-#     class ActionSpatialUnitCommand < Google::Protobuf::AbstractMessage; end;
+#     class ActionSpatialUnitCommand end;
 #     # Protobuf virtual class.
-#     class BuildItem < Google::Protobuf::AbstractMessage; end;
+#     class BuildItem end;
 #     # Protobuf virtual class.
-#     class ActionToggleAutocast < Google::Protobuf::AbstractMessage; end;
+#     class ActionToggleAutocast end;
 #   end
 
 
@@ -47,13 +47,258 @@
 # Protobuf classes
 # @!parse
 #   module Api;
-#     # Protobuf virtual enum.
-#     class Race < Google::Protobuf::AbstractMessage; end;
-#     # Protobuf virtual enum.
-#     class PlayerType < Google::Protobuf::AbstractMessage; end;
-#     # Protobuf virtual enum.
-#     class Difficulty < Google::Protobuf::AbstractMessage; end;
-#     # Protobuf virtual enum.
-#     class AIBuild < Google::Protobuf::AbstractMessage; end;
+#     # PROTOBUF VIRTUAL ENUM.
+#     module Race
+#       NO_RACE = 0
+#       TERRAN = 1
+#       ZERG = 2
+#       PROTOSS = 3
+#       RANDOM = 4
+#    end
+#     # PROTOBUF VIRTUAL ENUM.
+#     module PlayerType
+#       PARTICIPANT = 1
+#       COMPUTER = 2
+#       OBSERVER = 3
+#    end
+#     # PROTOBUF VIRTUAL ENUM.
+#     module Difficulty
+#       VERY_EASY = 1
+#       EASY = 2
+#       MEDIUM = 3
+#       MEDIUM_HARD = 4
+#       HARD = 5
+#       HARDER = 6
+#       VERY_HARD = 7
+#       CHEAT_VISION = 8
+#       CHEAT_MONEY = 9
+#       CHEAT_INSANE = 10
+#    end
+#     # PROTOBUF VIRTUAL ENUM.
+#     module AIBuild
+#       RANDOM_BUILD = 1
+#       RUSH = 2
+#       TIMING = 3
+#       POWER = 4
+#       MACRO = 5
+#       AIR = 6
+#    end
+#     # PROTOBUF VIRTUAL ENUM.
+#     module ActionResult
+#       SUCCESS = 1;
+#       NOT_SUPPORTED = 2;
+#       ERROR = 3;
+#       CANT_QUEUE_THAT_ORDER = 4;
+#       RETRY = 5;
+#       COOLDOWN = 6;
+#       QUEUE_IS_FULL = 7;
+#       RALLY_QUEUE_IS_FULL = 8;
+#       NOT_ENOUGH_MINERALS = 9;
+#       NOT_ENOUGH_VESPENE = 10;
+#       NOT_ENOUGH_TERRAZINE = 11;
+#       NOT_ENOUGH_CUSTOM = 12;
+#       NOT_ENOUGH_FOOD = 13;
+#       FOOD_USAGE_IMPOSSIBLE = 14;
+#       NOT_ENOUGH_LIFE = 15;
+#       NOT_ENOUGH_SHIELDS = 16;
+#       NOT_ENOUGH_ENERGY = 17;
+#       LIFE_SUPPRESSED = 18;
+#       SHIELDS_SUPPRESSED = 19;
+#       ENERGY_SUPPRESSED = 20;
+#       NOT_ENOUGH_CHARGES = 21;
+#       CANT_ADD_MORE_CHARGES = 22;
+#       TOO_MUCH_MINERALS = 23;
+#       TOO_MUCH_VESPENE = 24;
+#       TOO_MUCH_TERRAZINE = 25;
+#       TOO_MUCH_CUSTOM = 26;
+#       TOO_MUCH_FOOD = 27;
+#       TOO_MUCH_LIFE = 28;
+#       TOO_MUCH_SHIELDS = 29;
+#       TOO_MUCH_ENERGY = 30;
+#       MUST_TARGET_UNIT_WITH_LIFE = 31;
+#       MUST_TARGET_UNIT_WITH_SHIELDS = 32;
+#       MUST_TARGET_UNIT_WITH_ENERGY = 33;
+#       CANT_TRADE = 34;
+#       CANT_SPEND = 35;
+#       CANT_TARGET_THAT_UNIT = 36;
+#       COULDNT_ALLOCATE_UNIT = 37;
+#       UNIT_CANT_MOVE = 38;
+#       TRANSPORT_IS_HOLDING_POSITION = 39;
+#       BUILD_TECH_REQUIREMENTS_NOT_MET = 40;
+#       CANT_FIND_PLACEMENT_LOCATION = 41;
+#       CANT_BUILD_ON_THAT = 42;
+#       CANT_BUILD_TOO_CLOSE_TO_DROP_OFF = 43;
+#       CANT_BUILD_LOCATION_INVALID = 44;
+#       CANT_SEE_BUILD_LOCATION = 45;
+#       CANT_BUILD_TOO_CLOSE_TO_CREEP_SOURCE = 46;
+#       CANT_BUILD_TOO_CLOSE_TO_RESOURCES = 47;
+#       CANT_BUILD_TOO_FAR_FROM_WATER = 48;
+#       CANT_BUILD_TOO_FAR_FROM_CREEP_SOURCE = 49;
+#       CANT_BUILD_TOO_FAR_FROM_BUILD_POWER_SOURCE = 50;
+#       CANT_BUILD_ON_DENSE_TERRAIN = 51;
+#       CANT_TRAIN_TOO_FAR_FROM_TRAIN_POWER_SOURCE = 52;
+#       CANT_LAND_LOCATION_INVALID = 53;
+#       CANT_SEE_LAND_LOCATION = 54;
+#       CANT_LAND_TOO_CLOSE_TO_CREEP_SOURCE = 55;
+#       CANT_LAND_TOO_CLOSE_TO_RESOURCES = 56;
+#       CANT_LAND_TOO_FAR_FROM_WATER = 57;
+#       CANT_LAND_TOO_FAR_FROM_CREEP_SOURCE = 58;
+#       CANT_LAND_TOO_FAR_FROM_BUILD_POWER_SOURCE = 59;
+#       CANT_LAND_TOO_FAR_FROM_TRAIN_POWER_SOURCE = 60;
+#       CANT_LAND_ON_DENSE_TERRAIN = 61;
+#       ADD_ON_TOO_FAR_FROM_BUILDING = 62;
+#       MUST_BUILD_REFINERY_FIRST = 63;
+#       BUILDING_IS_UNDER_CONSTRUCTION = 64;
+#       CANT_FIND_DROP_OFF = 65;
+#       CANT_LOAD_OTHER_PLAYERS_UNITS = 66;
+#       NOT_ENOUGH_ROOM_TO_LOAD_UNIT = 67;
+#       CANT_UNLOAD_UNITS_THERE = 68;
+#       CANT_WARP_IN_UNITS_THERE = 69;
+#       CANT_LOAD_IMMOBILE_UNITS = 70;
+#       CANT_RECHARGE_IMMOBILE_UNITS = 71;
+#       CANT_RECHARGE_UNDER_CONSTRUCTION_UNITS = 72;
+#       CANT_LOAD_THAT_UNIT = 73;
+#       NO_CARGO_TO_UNLOAD = 74;
+#       LOAD_ALL_NO_TARGETS_FOUND = 75;
+#       NOT_WHILE_OCCUPIED = 76;
+#       CANT_ATTACK_WITHOUT_AMMO = 77;
+#       CANT_HOLD_ANY_MORE_AMMO = 78;
+#       TECH_REQUIREMENTS_NOT_MET = 79;
+#       MUST_LOCKDOWN_UNIT_FIRST = 80;
+#       MUST_TARGET_UNIT = 81;
+#       MUST_TARGET_INVENTORY = 82;
+#       MUST_TARGET_VISIBLE_UNIT = 83;
+#       MUST_TARGET_VISIBLE_LOCATION = 84;
+#       MUST_TARGET_WALKABLE_LOCATION = 85;
+#       MUST_TARGET_PAWNABLE_UNIT = 86;
+#       YOU_CANT_CONTROL_THAT_UNIT = 87;
+#       YOU_CANT_ISSUE_COMMANDS_TO_THAT_UNIT = 88;
+#       MUST_TARGET_RESOURCES = 89;
+#       REQUIRES_HEAL_TARGET = 90;
+#       REQUIRES_REPAIR_TARGET = 91;
+#       NO_ITEMS_TO_DROP = 92;
+#       CANT_HOLD_ANY_MORE_ITEMS = 93;
+#       CANT_HOLD_THAT = 94;
+#       TARGET_HAS_NO_INVENTORY = 95;
+#       CANT_DROP_THIS_ITEM = 96;
+#       CANT_MOVE_THIS_ITEM = 97;
+#       CANT_PAWN_THIS_UNIT = 98;
+#       MUST_TARGET_CASTER = 99;
+#       CANT_TARGET_CASTER = 100;
+#       MUST_TARGET_OUTER = 101;
+#       CANT_TARGET_OUTER = 102;
+#       MUST_TARGET_YOUR_OWN_UNITS = 103;
+#       CANT_TARGET_YOUR_OWN_UNITS = 104;
+#       MUST_TARGET_FRIENDLY_UNITS = 105;
+#       CANT_TARGET_FRIENDLY_UNITS = 106;
+#       MUST_TARGET_NEUTRAL_UNITS = 107;
+#       CANT_TARGET_NEUTRAL_UNITS = 108;
+#       MUST_TARGET_ENEMY_UNITS = 109;
+#       CANT_TARGET_ENEMY_UNITS = 110;
+#       MUST_TARGET_AIR_UNITS = 111;
+#       CANT_TARGET_AIR_UNITS = 112;
+#       MUST_TARGET_GROUND_UNITS = 113;
+#       CANT_TARGET_GROUND_UNITS = 114;
+#       MUST_TARGET_STRUCTURES = 115;
+#       CANT_TARGET_STRUCTURES = 116;
+#       MUST_TARGET_LIGHT_UNITS = 117;
+#       CANT_TARGET_LIGHT_UNITS = 118;
+#       MUST_TARGET_ARMORED_UNITS = 119;
+#       CANT_TARGET_ARMORED_UNITS = 120;
+#       MUST_TARGET_BIOLOGICAL_UNITS = 121;
+#       CANT_TARGET_BIOLOGICAL_UNITS = 122;
+#       MUST_TARGET_HEROIC_UNITS = 123;
+#       CANT_TARGET_HEROIC_UNITS = 124;
+#       MUST_TARGET_ROBOTIC_UNITS = 125;
+#       CANT_TARGET_ROBOTIC_UNITS = 126;
+#       MUST_TARGET_MECHANICAL_UNITS = 127;
+#       CANT_TARGET_MECHANICAL_UNITS = 128;
+#       MUST_TARGET_PSIONIC_UNITS = 129;
+#       CANT_TARGET_PSIONIC_UNITS = 130;
+#       MUST_TARGET_MASSIVE_UNITS = 131;
+#       CANT_TARGET_MASSIVE_UNITS = 132;
+#       MUST_TARGET_MISSILE = 133;
+#       CANT_TARGET_MISSILE = 134;
+#       MUST_TARGET_WORKER_UNITS = 135;
+#       CANT_TARGET_WORKER_UNITS = 136;
+#       MUST_TARGET_ENERGY_CAPABLE_UNITS = 137;
+#       CANT_TARGET_ENERGY_CAPABLE_UNITS = 138;
+#       MUST_TARGET_SHIELD_CAPABLE_UNITS = 139;
+#       CANT_TARGET_SHIELD_CAPABLE_UNITS = 140;
+#       MUST_TARGET_FLYERS = 141;
+#       CANT_TARGET_FLYERS = 142;
+#       MUST_TARGET_BURIED_UNITS = 143;
+#       CANT_TARGET_BURIED_UNITS = 144;
+#       MUST_TARGET_CLOAKED_UNITS = 145;
+#       CANT_TARGET_CLOAKED_UNITS = 146;
+#       MUST_TARGET_UNITS_IN_A_STASIS_FIELD = 147;
+#       CANT_TARGET_UNITS_IN_A_STASIS_FIELD = 148;
+#       MUST_TARGET_UNDER_CONSTRUCTION_UNITS = 149;
+#       CANT_TARGET_UNDER_CONSTRUCTION_UNITS = 150;
+#       MUST_TARGET_DEAD_UNITS = 151;
+#       CANT_TARGET_DEAD_UNITS = 152;
+#       MUST_TARGET_REVIVABLE_UNITS = 153;
+#       CANT_TARGET_REVIVABLE_UNITS = 154;
+#       MUST_TARGET_HIDDEN_UNITS = 155;
+#       CANT_TARGET_HIDDEN_UNITS = 156;
+#       CANT_RECHARGE_OTHER_PLAYERS_UNITS = 157;
+#       MUST_TARGET_HALLUCINATIONS = 158;
+#       CANT_TARGET_HALLUCINATIONS = 159;
+#       MUST_TARGET_INVULNERABLE_UNITS = 160;
+#       CANT_TARGET_INVULNERABLE_UNITS = 161;
+#       MUST_TARGET_DETECTED_UNITS = 162;
+#       CANT_TARGET_DETECTED_UNITS = 163;
+#       CANT_TARGET_UNIT_WITH_ENERGY = 164;
+#       CANT_TARGET_UNIT_WITH_SHIELDS = 165;
+#       MUST_TARGET_UNCOMMANDABLE_UNITS = 166;
+#       CANT_TARGET_UNCOMMANDABLE_UNITS = 167;
+#       MUST_TARGET_PREVENT_DEFEAT_UNITS = 168;
+#       CANT_TARGET_PREVENT_DEFEAT_UNITS = 169;
+#       MUST_TARGET_PREVENT_REVEAL_UNITS = 170;
+#       CANT_TARGET_PREVENT_REVEAL_UNITS = 171;
+#       MUST_TARGET_PASSIVE_UNITS = 172;
+#       CANT_TARGET_PASSIVE_UNITS = 173;
+#       MUST_TARGET_STUNNED_UNITS = 174;
+#       CANT_TARGET_STUNNED_UNITS = 175;
+#       MUST_TARGET_SUMMONED_UNITS = 176;
+#       CANT_TARGET_SUMMONED_UNITS = 177;
+#       MUST_TARGET_USER1 = 178;
+#       CANT_TARGET_USER1 = 179;
+#       MUST_TARGET_UNSTOPPABLE_UNITS = 180;
+#       CANT_TARGET_UNSTOPPABLE_UNITS = 181;
+#       MUST_TARGET_RESISTANT_UNITS = 182;
+#       CANT_TARGET_RESISTANT_UNITS = 183;
+#       MUST_TARGET_DAZED_UNITS = 184;
+#       CANT_TARGET_DAZED_UNITS = 185;
+#       CANT_LOCKDOWN = 186;
+#       CANT_MIND_CONTROL = 187;
+#       MUST_TARGET_DESTRUCTIBLES = 188;
+#       CANT_TARGET_DESTRUCTIBLES = 189;
+#       MUST_TARGET_ITEMS = 190;
+#       CANT_TARGET_ITEMS = 191;
+#       NO_CALLDOWN_AVAILABLE = 192;
+#       WAYPOINT_LIST_FULL = 193;
+#       MUST_TARGET_RACE = 194;
+#       CANT_TARGET_RACE = 195;
+#       MUST_TARGET_SIMILAR_UNITS = 196;
+#       CANT_TARGET_SIMILAR_UNITS = 197;
+#       CANT_FIND_ENOUGH_TARGETS = 198;
+#       ALREADY_SPAWNING_LARVA = 199;
+#       CANT_TARGET_EXHAUSTED_RESOURCES = 200;
+#       CANT_USE_MINIMAP = 201;
+#       CANT_USE_INFO_PANEL = 202;
+#       ORDER_QUEUE_IS_FULL = 203;
+#       CANT_HARVEST_THAT_RESOURCE = 204;
+#       HARVESTERS_NOT_REQUIRED = 205;
+#       ALREADY_TARGETED = 206;
+#       CANT_ATTACK_WEAPONS_DISABLED = 207;
+#       COULDNT_REACH_TARGET = 208;
+#       TARGET_IS_OUT_OF_RANGE = 209;
+#       TARGET_IS_TOO_CLOSE = 210;
+#       TARGET_IS_OUT_OF_ARC = 211;
+#       CANT_FIND_TELEPORT_LOCATION = 212;
+#       INVALID_ITEM_CLASS = 213;
+#       CANT_FIND_CANCEL_ORDER = 214;
+#    end
 #   end
 # @!parse