sc2ai 0.0.0.pre → 0.0.2

data/lib/sc2ai/api/buff_id.rb

@@ -0,0 +1,306 @@
+# Generated from stableid.json, do not edit.
+
+module Api
+  # Constant reference of Buff ids
+  module BuffId
+    NULL = 0
+    RADAR25 = 1
+    TAUNTB = 2
+    DISABLEABILS = 3
+    TRANSIENTMORPH = 4
+    GRAVITONBEAM = 5
+    GHOSTCLOAK = 6
+    BANSHEECLOAK = 7
+    POWERUSERWARPABLE = 8
+    VORTEXBEHAVIORENEMY = 9
+    CORRUPTION = 10
+    QUEENSPAWNLARVATIMER = 11
+    GHOSTHOLDFIRE = 12
+    GHOSTHOLDFIREB = 13
+    LEECH = 14
+    LEECHDISABLEABILITIES = 15
+    EMPDECLOAK = 16
+    FUNGALGROWTH = 17
+    GUARDIANSHIELD = 18
+    SEEKERMISSILETIMEOUT = 19
+    TIMEWARPPRODUCTION = 20
+    ETHEREAL = 21
+    NEURALPARASITE = 22
+    NEURALPARASITEWAIT = 23
+    STIMPACKMARAUDER = 24
+    SUPPLYDROP = 25
+    def self._250MMSTRIKECANNONS = 26
+    STIMPACK = 27
+    PSISTORM = 28
+    CLOAKFIELDEFFECT = 29
+    CHARGING = 30
+    AIDANGERBUFF = 31
+    VORTEXBEHAVIOR = 32
+    SLOW = 33
+    TEMPORALRIFTUNIT = 34
+    SHEEPBUSY = 35
+    CONTAMINATED = 36
+    TIMESCALECONVERSIONBEHAVIOR = 37
+    BLINDINGCLOUDSTRUCTURE = 38
+    COLLAPSIBLEROCKTOWERCONJOINEDSEARCH = 39
+    COLLAPSIBLEROCKTOWERRAMPDIAGONALCONJOINEDSEARCH = 40
+    COLLAPSIBLETERRANTOWERCONJOINEDSEARCH = 41
+    COLLAPSIBLETERRANTOWERRAMPDIAGONALCONJOINEDSEARCH = 42
+    DIGESTERCREEPSPRAYVISION = 43
+    INVULNERABILITYSHIELD = 44
+    MINEDRONECOUNTDOWN = 45
+    MOTHERSHIPSTASIS = 46
+    MOTHERSHIPSTASISCASTER = 47
+    MOTHERSHIPCOREENERGIZEVISUAL = 48
+    ORACLEREVELATION = 49
+    GHOSTSNIPEDOT = 50
+    NEXUSPHASESHIFT = 51
+    NEXUSINVULNERABILITY = 52
+    ROUGHTERRAINSEARCH = 53
+    ROUGHTERRAINSLOW = 54
+    ORACLECLOAKFIELD = 55
+    ORACLECLOAKFIELDEFFECT = 56
+    SCRYERFRIENDLY = 57
+    SPECTRESHIELD = 58
+    VIPERCONSUMESTRUCTURE = 59
+    RESTORESHIELDS = 60
+    MERCENARYCYCLONEMISSILES = 61
+    MERCENARYSENSORDISH = 62
+    MERCENARYSHIELD = 63
+    SCRYER = 64
+    STUNROUNDINITIALBEHAVIOR = 65
+    BUILDINGSHIELD = 66
+    LASERSIGHT = 67
+    PROTECTIVEBARRIER = 68
+    CORRUPTORGROUNDATTACKDEBUFF = 69
+    BATTLECRUISERANTIAIRDISABLE = 70
+    BUILDINGSTASIS = 71
+    STASIS = 72
+    RESOURCESTUN = 73
+    MAXIMUMTHRUST = 74
+    CHARGEUP = 75
+    CLOAKUNIT = 76
+    NULLFIELD = 77
+    RESCUE = 78
+    BENIGN = 79
+    LASERTARGETING = 80
+    ENGAGE = 81
+    CAPRESOURCE = 82
+    BLINDINGCLOUD = 83
+    DOOMDAMAGEDELAY = 84
+    EYESTALK = 85
+    BURROWCHARGE = 86
+    HIDDEN = 87
+    MINEDRONEDOT = 88
+    MEDIVACSPEEDBOOST = 89
+    EXTENDBRIDGEEXTENDINGBRIDGENEWIDE8OUT = 90
+    EXTENDBRIDGEEXTENDINGBRIDGENWWIDE8OUT = 91
+    EXTENDBRIDGEEXTENDINGBRIDGENEWIDE10OUT = 92
+    EXTENDBRIDGEEXTENDINGBRIDGENWWIDE10OUT = 93
+    EXTENDBRIDGEEXTENDINGBRIDGENEWIDE12OUT = 94
+    EXTENDBRIDGEEXTENDINGBRIDGENWWIDE12OUT = 95
+    PHASESHIELD = 96
+    PURIFY = 97
+    VOIDSIPHON = 98
+    ORACLEWEAPON = 99
+    ANTIAIRWEAPONSWITCHCOOLDOWN = 100
+    ARBITERMPSTASISFIELD = 101
+    IMMORTALOVERLOAD = 102
+    CLOAKINGFIELDTARGETED = 103
+    LIGHTNINGBOMB = 104
+    ORACLEPHASESHIFT = 105
+    RELEASEINTERCEPTORSCOOLDOWN = 106
+    RELEASEINTERCEPTORSTIMEDLIFEWARNING = 107
+    RELEASEINTERCEPTORSWANDERDELAY = 108
+    RELEASEINTERCEPTORSBEACON = 109
+    ARBITERMPCLOAKFIELDEFFECT = 110
+    PURIFICATIONNOVA = 111
+    CORRUPTIONBOMBDAMAGE = 112
+    CORSAIRMPDISRUPTIONWEB = 113
+    DISRUPTORPUSH = 114
+    LIGHTOFAIUR = 115
+    LOCKON = 116
+    OVERCHARGE = 117
+    OVERCHARGEDAMAGE = 118
+    OVERCHARGESPEEDBOOST = 119
+    SEEKERMISSILE = 120
+    TEMPORALFIELD = 121
+    VOIDRAYSWARMDAMAGEBOOST = 122
+    VOIDMPIMMORTALREVIVESUPRESSED = 123
+    DEVOURERMPACIDSPORES = 124
+    DEFILERMPCONSUME = 125
+    DEFILERMPDARKSWARM = 126
+    DEFILERMPPLAGUE = 127
+    QUEENMPENSNARE = 128
+    ORACLESTASISTRAPTARGET = 129
+    SELFREPAIR = 130
+    AGGRESSIVEMUTATION = 131
+    PARASITICBOMB = 132
+    PARASITICBOMBUNITKU = 133
+    PARASITICBOMBSECONDARYUNITSEARCH = 134
+    ADEPTDEATHCHECK = 135
+    LURKERHOLDFIRE = 136
+    LURKERHOLDFIREB = 137
+    TIMESTOPSTUN = 138
+    SLAYNELEMENTALGRABSTUN = 139
+    PURIFICATIONNOVAPOST = 140
+    DISABLEINTERCEPTORS = 141
+    BYPASSARMORDEBUFFONE = 142
+    BYPASSARMORDEBUFFTWO = 143
+    BYPASSARMORDEBUFFTHREE = 144
+    CHANNELSNIPECOMBAT = 145
+    TEMPESTDISRUPTIONBLASTSTUNBEHAVIOR = 146
+    GRAVITONPRISON = 147
+    INFESTORDISEASE = 148
+    SS_LIGHTNINGPROJECTOR = 149
+    PURIFIERPLANETCRACKERCHARGE = 150
+    SPECTRECLOAKING = 151
+    WRAITHCLOAK = 152
+    PSYTROUSOXIDE = 153
+    BANSHEECLOAKCROSSSPECTRUMDAMPENERS = 154
+    SS_BATTLECRUISERHUNTERSEEKERTIMEOUT = 155
+    SS_STRONGERENEMYBUFF = 156
+    SS_TERRATRONARMMISSILETARGETCHECK = 157
+    SS_MISSILETIMEOUT = 158
+    SS_LEVIATHANBOMBCOLLISIONCHECK = 159
+    SS_LEVIATHANBOMBEXPLODETIMER = 160
+    SS_LEVIATHANBOMBMISSILETARGETCHECK = 161
+    SS_TERRATRONCOLLISIONCHECK = 162
+    SS_CARRIERBOSSCOLLISIONCHECK = 163
+    SS_CORRUPTORMISSILETARGETCHECK = 164
+    SS_INVULNERABLE = 165
+    SS_LEVIATHANTENTACLEMISSILETARGETCHECK = 166
+    SS_LEVIATHANTENTACLEMISSILETARGETCHECKINVERTED = 167
+    SS_LEVIATHANTENTACLETARGETDEATHDELAY = 168
+    SS_LEVIATHANTENTACLEMISSILESCANSWAPDELAY = 169
+    SS_POWERUPDIAGONAL2 = 170
+    SS_BATTLECRUISERCOLLISIONCHECK = 171
+    SS_TERRATRONMISSILESPINNERMISSILELAUNCHER = 172
+    SS_TERRATRONMISSILESPINNERCOLLISIONCHECK = 173
+    SS_TERRATRONMISSILELAUNCHER = 174
+    SS_BATTLECRUISERMISSILELAUNCHER = 175
+    SS_TERRATRONSTUN = 176
+    SS_VIKINGRESPAWN = 177
+    SS_WRAITHCOLLISIONCHECK = 178
+    SS_SCOURGEMISSILETARGETCHECK = 179
+    SS_SCOURGEDEATH = 180
+    SS_SWARMGUARDIANCOLLISIONCHECK = 181
+    SS_FIGHTERBOMBMISSILEDEATH = 182
+    SS_FIGHTERDRONEDAMAGERESPONSE = 183
+    SS_INTERCEPTORCOLLISIONCHECK = 184
+    SS_CARRIERCOLLISIONCHECK = 185
+    SS_MISSILETARGETCHECKVIKINGDRONE = 186
+    SS_MISSILETARGETCHECKVIKINGSTRONG1 = 187
+    SS_MISSILETARGETCHECKVIKINGSTRONG2 = 188
+    SS_POWERUPHEALTH1 = 189
+    SS_POWERUPHEALTH2 = 190
+    SS_POWERUPSTRONG = 191
+    SS_POWERUPMORPHTOBOMB = 192
+    SS_POWERUPMORPHTOHEALTH = 193
+    SS_POWERUPMORPHTOSIDEMISSILES = 194
+    SS_POWERUPMORPHTOSTRONGERMISSILES = 195
+    SS_CORRUPTORCOLLISIONCHECK = 196
+    SS_SCOUTCOLLISIONCHECK = 197
+    SS_PHOENIXCOLLISIONCHECK = 198
+    SS_SCOURGECOLLISIONCHECK = 199
+    SS_LEVIATHANCOLLISIONCHECK = 200
+    SS_SCIENCEVESSELCOLLISIONCHECK = 201
+    SS_TERRATRONSAWCOLLISIONCHECK = 202
+    SS_LIGHTNINGPROJECTORCOLLISIONCHECK = 203
+    SHIFTDELAY = 204
+    BIOSTASIS = 205
+    PERSONALCLOAKINGFREE = 206
+    EMPDRAIN = 207
+    MINDBLASTSTUN = 208
+    def self._330MMBARRAGECANNONS = 209
+    VOODOOSHIELD = 210
+    SPECTRECLOAKINGFREE = 211
+    ULTRASONICPULSESTUN = 212
+    IRRADIATE = 213
+    NYDUSWORMLAVAINSTANTDEATH = 214
+    PREDATORCLOAKING = 215
+    PSIDISRUPTION = 216
+    MINDCONTROL = 217
+    QUEENKNOCKDOWN = 218
+    SCIENCEVESSELCLOAKFIELD = 219
+    SPORECANNONMISSILE = 220
+    ARTANISTEMPORALRIFTUNIT = 221
+    ARTANISCLOAKINGFIELDEFFECT = 222
+    ARTANISVORTEXBEHAVIOR = 223
+    INCAPACITATED = 224
+    KARASSPSISTORM = 225
+    DUTCHMARAUDERSLOW = 226
+    JUMPSTOMPSTUN = 227
+    JUMPSTOMPFSTUN = 228
+    RAYNORMISSILETIMEDLIFE = 229
+    PSIONICSHOCKWAVEHEIGHTANDSTUN = 230
+    SHADOWCLONE = 231
+    AUTOMATEDREPAIR = 232
+    SLIMED = 233
+    RAYNORTIMEBOMBMISSILE = 234
+    RAYNORTIMEBOMBUNIT = 235
+    TYCHUSCOMMANDOSTIMPACK = 236
+    VIRALPLASMA = 237
+    NAPALM = 238
+    BURSTCAPACITORSDAMAGEBUFF = 239
+    COLONYINFESTATION = 240
+    DOMINATION = 241
+    EMPBURST = 242
+    HYBRIDCZERGYROOTS = 243
+    HYBRIDFZERGYROOTS = 244
+    LOCKDOWNB = 245
+    SPECTRELOCKDOWNB = 246
+    VOODOOLOCKDOWN = 247
+    ZERATULSTUN = 248
+    BUILDINGSCARAB = 249
+    VORTEXBEHAVIORERADICATOR = 250
+    GHOSTBLAST = 251
+    HEROICBUFF03 = 252
+    CANNONRADAR = 253
+    SS_MISSILETARGETCHECKVIKING = 254
+    SS_MISSILETARGETCHECK = 255
+    SS_MAXSPEED = 256
+    SS_MAXACCELERATION = 257
+    SS_POWERUPDIAGONAL1 = 258
+    WATER = 259
+    DEFENSIVEMATRIX = 260
+    TESTATTRIBUTE = 261
+    TESTVETERANCY = 262
+    SHREDDERSWARMDAMAGEAPPLY = 263
+    CORRUPTORINFESTING = 264
+    MERCGROUNDDROPDELAY = 265
+    MERCGROUNDDROP = 266
+    MERCAIRDROPDELAY = 267
+    SPECTREHOLDFIRE = 268
+    SPECTREHOLDFIREB = 269
+    ITEMGRAVITYBOMBS = 270
+    CARRYMINERALFIELDMINERALS = 271
+    CARRYHIGHYIELDMINERALFIELDMINERALS = 272
+    CARRYHARVESTABLEVESPENEGEYSERGAS = 273
+    CARRYHARVESTABLEVESPENEGEYSERGASPROTOSS = 274
+    CARRYHARVESTABLEVESPENEGEYSERGASZERG = 275
+    PERMANENTLYCLOAKED = 276
+    RAVENSCRAMBLERMISSILE = 277
+    RAVENSHREDDERMISSILETIMEOUT = 278
+    RAVENSHREDDERMISSILETINT = 279
+    RAVENSHREDDERMISSILEARMORREDUCTION = 280
+    CHRONOBOOSTENERGYCOST = 281
+    NEXUSSHIELDRECHARGEONPYLONBEHAVIOR = 282
+    NEXUSSHIELDRECHARGEONPYLONBEHAVIORSECONDARYONTARGET = 283
+    INFESTORENSNARE = 284
+    INFESTORENSNAREMAKEPRECURSORREHEIGHTSOURCE = 285
+    NEXUSSHIELDOVERCHARGE = 286
+    PARASITICBOMBDELAYTIMEDLIFE = 287
+    TRANSFUSION = 288
+    ACCELERATIONZONETEMPORALFIELD = 289
+    ACCELERATIONZONEFLYINGTEMPORALFIELD = 290
+    INHIBITORZONEFLYINGTEMPORALFIELD = 291
+    LOADOUTSPRAYTRACKER = 292
+    INHIBITORZONETEMPORALFIELD = 293
+    RESONATINGGLAIVESPHASESHIFT = 294
+    NEURALPARASITECHILDREN = 295
+    AMORPHOUSARMORCLOUD = 296
+    RAVENSHREDDERMISSILEARMORREDUCTIONUISUBTRUCT = 297
+    BATTERYOVERCHARGE = 298
+  end
+end

data/lib/sc2ai/api/data.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require_relative "ability_id"
+require_relative "unit_type_id"
+require_relative "upgrade_id"
+require_relative "buff_id"
+require_relative "effect_id"
+require_relative "tech_tree"
+
+module Sc2
+  # Holds game data from tech tree and Api::ResponseData
+  # Called once on game start
+  class Data
+    # @!attribute abilities
+    #   @return [Hash<Integer, Api::AbilityData>]  AbilityId => AbilityData
+    attr_accessor :abilities
+    # @!attribute units
+    #   @return [Hash<Integer, Api::UnitTypeData>] UnitId => UnitData
+    attr_accessor :units
+    # @!attribute upgrades
+    #   @return [Hash<Integer, Api::UnitTypeData>] UnitTypeId => UnitTypeData
+    attr_accessor :upgrades
+    # @!attribute buffs
+    # Not particularly useful data. Just use BuffId directly
+    #   @return [Hash<Integer, Api::BuffData>] BuffId => BuffData
+    attr_accessor :buffs
+    # @!attribute effects
+    # Not particularly useful data. Just use EffectId directly
+    #   @return [Hash<Integer, Api::EffectData>] EffectId => EffectData
+    attr_accessor :effects
+
+    # @param data [Api::ResponseData]
+    def initialize(data)
+      return unless data
+
+      @abilities = abilities_from_proto(data.abilities)
+      @units = units_from_proto(data.units)
+      @upgrades = upgrades_from_proto(data.upgrades)
+      @buffs = buffs_from_proto(data.buffs)
+      @effects = effects_from_proto(data.effects)
+    end
+
+    private
+
+    # Indexes ability data by ability id
+    # @param abilities [Array<Api::AbilityData>]
+    # @return [Hash<Integer, Api::AbilityData] indexed data
+    def abilities_from_proto(abilities)
+      result = {}
+
+      ability_ids = Api::AbilityId.constants.map { |c| Api::AbilityId.const_get(c) }
+      abilities.each do |a|
+        next if a.ability_id.zero?
+        next if ability_ids.delete(a.ability_id).nil?
+
+        result[a.ability_id] = a
+      end
+      result
+    end
+
+    # Indexes unit data by id
+    # @param units [Array<Api::UnitTypeData>]
+    # @return [Hash<Integer, Api::UnitTypeData] indexed data
+    def units_from_proto(units)
+      result = {}
+      units.each do |u|
+        next unless u.available
+
+        result[u.unit_id] = u
+      end
+      result
+    end
+
+    # Indexes upgrades data by id
+    # @param upgrades [Array<Api::UpgradeData>]
+    # @return [Hash<Integer, Api::UpgradeData] indexed data
+    def upgrades_from_proto(upgrades)
+      result = {}
+      upgrades.each do |u|
+        result[u.upgrade_id] = u
+      end
+      result
+    end
+
+    def effects_from_proto(effects)
+      result = {}
+      effects.each do |e|
+        result[e.effect_id] = e
+      end
+      result
+    end
+
+    def buffs_from_proto(buffs)
+      result = {}
+      buffs.each do |b|
+        result[b.buff_id] = b
+      end
+      result
+    end
+  end
+end

data/lib/sc2ai/api/effect_id.rb

@@ -0,0 +1,20 @@
+# Generated from stableid.json, do not edit.
+
+module Api
+  # Constant reference of Effect ids
+  module EffectId
+    NULL = 0
+    PSISTORMPERSISTENT = 1
+    GUARDIANSHIELDPERSISTENT = 2
+    TEMPORALFIELDGROWINGBUBBLECREATEPERSISTENT = 3
+    TEMPORALFIELDAFTERBUBBLECREATEPERSISTENT = 4
+    THERMALLANCESFORWARD = 5
+    SCANNERSWEEP = 6
+    NUKEPERSISTENT = 7
+    LIBERATORTARGETMORPHDELAYPERSISTENT = 8
+    LIBERATORTARGETMORPHPERSISTENT = 9
+    BLINDINGCLOUDCP = 10
+    RAVAGERCORROSIVEBILECP = 11
+    LURKERMP = 12
+  end
+end

data/lib/sc2ai/api/tech_tree.rb

@@ -0,0 +1,83 @@
+require_relative "tech_tree_data"
+
+
+module Api
+  # Provides helper functions which work with and rely on auto generated data in tech_tree_data.rb
+  # To lighten code generation, these methods live in a file of their own and may be modified.
+  module TechTree
+    class << self
+      # Get units can be created at source + the ability to trigger it. Optionally target a specific unit from source
+      # @example
+      #  # The data we reference looks like this, unit_type_creation_abilities_data
+      #  UnitTypeId.FACTORY: {
+      #   UnitTypeId.CYCLONE: {
+      #     'ability': AbilityId.TRAIN_CYCLONE,
+      #     'requires_techlab': True
+      #   },
+      #   UnitTypeId.HELLION: {
+      #     'ability': AbilityId.FACTORYTRAIN_HELLION
+      #   },
+      #
+      #  Targeting only a source, i.e. factory, your results are all units
+      #  {
+      #   UnitTypeId.CYCLONE: {
+      #     'ability': AbilityId.TRAIN_CYCLONE,
+      #     'requires_techlab': True
+      #   },
+      #   UnitTypeId.HELLION: {
+      #     'ability': AbilityId.FACTORYTRAIN_HELLION
+      #   },...
+      #  }
+      #
+      #  To get the requirements, you could call a source and target like such
+      #  Api::TechTree.unit_type_creation_abilities(source: ..., target: ... )
+      #  {
+      #    "ability" => 123
+      #    "requires_techlab" => true
+      #    "required_building" => 456
+      #  }
+      # @param source [Integer] Api::UnitTypeId the unit type which will do the creation
+      # @param target [Integer] (optional) Api::UnitTypeId the unit type which will be created
+      # @return [Hash] either a hash of [UnitTypeId] => { ability hash } or { ability hash } when target is present
+      def unit_type_creation_abilities(source:, target: nil)
+        creates_unit_types = unit_type_creation_abilities_data[source]
+        unless target.nil?
+          return creates_unit_types[target]
+        end
+        creates_unit_types
+      end
+
+      # Which ability id creates the target, given the source unit/building
+      # @see Api::TechTree#unit_type_creation_abilities to get a full list of units and their creation abilities
+      # @param source [Integer] Api::UnitTypeId the unit type which will do the creation
+      # @param target [Integer] (optional) Api::UnitTypeId the unit type which will be created
+      # @return [Integer, nil] AbilityId or nil if target is not found at source
+      def unit_type_creation_ability_id(source:, target:)
+        ability_hash = unit_type_creation_abilities(source: source, target: target)
+        return ability_hash[:ability] if ability_hash && ability_hash[:ability]
+        nil
+      end
+
+      # Returns what unit types a specific unit type can produce
+      # @param unit_type_id [Integer] the unit which you want to check
+      # @return [Array<Integer>] returns an array of unit type ids as per Api:UnitTypeId
+      def creates_unit_types(unit_type_id:)
+        unit_type_creation_abilities_data[unit_type_id].keys
+      end
+
+      # Returns what the unit type another is created from
+      # @param unit_type_id [Integer] the unit which you want to check
+      # @return [Array<Integer>] returns an array of unit type ids as per Api:UnitTypeId
+      def unit_created_from(unit_type_id:)
+        unit_created_from_data[unit_type_id]
+      end
+
+      # Returns what the unit type an upgrade is researched from
+      # @param upgrade_id [Integer] the unit which you want to check
+      # @return [Integer] unit_type_id an array of unit type ids as per Api:UnitTypeId
+      def upgrade_researched_from(upgrade_id:)
+        upgrade_researched_from_data[upgrade_id]
+      end
+    end
+  end
+end