sc2nachos.ids.buff

Buff identifiers.

Hand-maintained: filtered to what multiplayer needs, named for readability. Each member is defined by a raw catalog member, never a literal id, or is a custom id, assigned auto(), which the game's ids read as. Unknown ids raise, but a unit's buffs pass over the few in BuffId._SKIPPED_IDS.

 1"""Buff identifiers.
 2
 3Hand-maintained: filtered to what multiplayer needs, named for readability. Each member is defined by a raw
 4catalog member, never a literal id, or is a custom id, assigned `auto()`, which the game's ids read as. Unknown ids
 5raise, but a unit's buffs pass over the few in `BuffId._SKIPPED_IDS`.
 6"""
 7
 8from enum import auto, nonmember
 9from types import MappingProxyType
10
11from sc2nachos.ids._id_enum import IdEnum
12from sc2nachos.ids.raw import RawBuffId
13
14
15class BuffId(IdEnum):
16    """Buff ids used in multiplayer games."""
17
18    ACCELERATION_ZONE = RawBuffId.AccelerationZoneTemporalField
19    ACCELERATION_ZONE_FLYING = RawBuffId.AccelerationZoneFlyingTemporalField
20    BANSHEE_CLOAK = RawBuffId.BansheeCloak
21    # From a plain geyser, under a game id for each race's worker; none comes from a rich one.
22    CARRYING_GAS = auto()
23    CARRYING_MINERALS = RawBuffId.CarryMineralFieldMinerals
24    CARRYING_MINERALS_RICH = RawBuffId.CarryHighYieldMineralFieldMinerals
25    CYCLONE_LOCKED_ON = RawBuffId.LockOn
26    GHOST_CLOAK = RawBuffId.GhostCloak
27    GHOST_EMP_DECLOAK = RawBuffId.EMPDecloak
28    GHOST_HOLD_FIRE = RawBuffId.GhostHoldFireB
29    GHOST_SNIPE = RawBuffId.ChannelSnipeCombat  # on the ghost, while it channels
30    HIGH_TEMPLAR_STORM = RawBuffId.PsiStorm
31    HYDRALISK_LUNGE = RawBuffId.HydraliskFrenzy
32    IMMORTAL_BARRIER = RawBuffId.TakenDamage
33    INFESTOR_FUNGAL_GROWTH = RawBuffId.FungalGrowth
34    INFESTOR_MICROBIAL_SHROUD = RawBuffId.AmorphousArmorcloud
35    INFESTOR_NEURAL_PARASITE = RawBuffId.NeuralParasite
36    INHIBITOR_ZONE = RawBuffId.InhibitorZoneTemporalField
37    INHIBITOR_ZONE_FLYING = RawBuffId.InhibitorZoneFlyingTemporalField
38    LURKER_HOLD_FIRE = RawBuffId.LurkerHoldFireB
39    MARAUDER_CONCUSSIVE_SHELLS_SLOW = RawBuffId.Slow
40    MARAUDER_STIMMED = RawBuffId.StimpackMarauder
41    MARINE_STIMMED = RawBuffId.Stimpack
42    MEDIVAC_BOOST = RawBuffId.MedivacSpeedBoost
43    MOTHERSHIP_CLOAK_FIELD = RawBuffId.CloakField  # on the mothership
44    MOTHERSHIP_CLOAK_FIELD_CLOAKED = RawBuffId.CloakFieldEffect  # on each unit the field cloaks
45    MOTHERSHIP_TIME_WARP = RawBuffId.TemporalField
46    NEXUS_CHRONO_BOOST = RawBuffId.ChronoBoostEnergyCost
47    ORACLE_PULSAR_BEAM = RawBuffId.OracleWeapon
48    ORACLE_REVELATION = RawBuffId.OracleRevelation
49    ORBITAL_COMMAND_SUPPLY_DROP = RawBuffId.SupplyDrop
50    OVERSEER_CONTAMINATED = RawBuffId.Contaminated
51    PHOENIX_GRAVITON_BEAM = RawBuffId.GravitonBeam
52    QUEEN_INJECTED = RawBuffId.QueenSpawnLarvaTimer  # counts down to the larvae, then again for a queued inject
53    QUEEN_TRANSFUSED = RawBuffId.Transfusion
54    RAVEN_ANTI_ARMOR_MISSILE = RawBuffId.RavenShredderMissileArmorReductionUISubtruct
55    RAVEN_ANTI_ARMOR_MISSILE_INCOMING = RawBuffId.RavenShredderMissileTint  # on its target, until the missile lands
56    RAVEN_INTERFERENCE_MATRIX = RawBuffId.RavenScramblerMissile
57    SENTRY_GUARDIAN_SHIELD = RawBuffId.GuardianShield
58    STASIS_WARD_TRAPPED = RawBuffId.OracleStasisTrapTarget  # on each unit the ward traps, never on the ward (in game)
59    VIPER_BLINDING_CLOUD = RawBuffId.BlindingCloud
60    VIPER_PARASITIC_BOMB = RawBuffId.ParasiticBomb  # on its target
61    VOID_RAY_PRISMATIC_ALIGNMENT = RawBuffId.VoidRaySwarmDamageBoost
62    WARP_GATE_WARPING_IN = RawBuffId.PowerUserWarpable  # on a unit warping in, until the step after it finishes
63    ZEALOT_CHARGING = RawBuffId.Charging  # on the zealot
64
65    # Each race's worker carries gas under a game id of its own (in game).
66    _REMAPPED_IDS = nonmember(
67        MappingProxyType(
68            {
69                RawBuffId.CarryHarvestableVespeneGeyserGas: CARRYING_GAS,
70                RawBuffId.CarryHarvestableVespeneGeyserGasProtoss: CARRYING_GAS,
71                RawBuffId.CarryHarvestableVespeneGeyserGasZerg: CARRYING_GAS,
72            }
73        )
74    )
75    # Every unit of one type wears each of these for as long as it is listed, so it says nothing the type does not
76    # (in game).
77    _SKIPPED_IDS = nonmember(
78        frozenset(
79            {
80                RawBuffId.ParasiticBombUnitKU,  # by `UnitTypeId.PARASITIC_BOMB_LEFT_BEHIND`
81                RawBuffId.ParasiticBombSecondaryUnitSearch,  # by `UnitTypeId.PARASITIC_BOMB_LEFT_BEHIND`
82            }
83        )
84    )
85    """Game ids that are no member's own and that a unit's buffs and the buff events pass over."""
class BuffId(sc2nachos.ids._id_enum.IdEnum):
16class BuffId(IdEnum):
17    """Buff ids used in multiplayer games."""
18
19    ACCELERATION_ZONE = RawBuffId.AccelerationZoneTemporalField
20    ACCELERATION_ZONE_FLYING = RawBuffId.AccelerationZoneFlyingTemporalField
21    BANSHEE_CLOAK = RawBuffId.BansheeCloak
22    # From a plain geyser, under a game id for each race's worker; none comes from a rich one.
23    CARRYING_GAS = auto()
24    CARRYING_MINERALS = RawBuffId.CarryMineralFieldMinerals
25    CARRYING_MINERALS_RICH = RawBuffId.CarryHighYieldMineralFieldMinerals
26    CYCLONE_LOCKED_ON = RawBuffId.LockOn
27    GHOST_CLOAK = RawBuffId.GhostCloak
28    GHOST_EMP_DECLOAK = RawBuffId.EMPDecloak
29    GHOST_HOLD_FIRE = RawBuffId.GhostHoldFireB
30    GHOST_SNIPE = RawBuffId.ChannelSnipeCombat  # on the ghost, while it channels
31    HIGH_TEMPLAR_STORM = RawBuffId.PsiStorm
32    HYDRALISK_LUNGE = RawBuffId.HydraliskFrenzy
33    IMMORTAL_BARRIER = RawBuffId.TakenDamage
34    INFESTOR_FUNGAL_GROWTH = RawBuffId.FungalGrowth
35    INFESTOR_MICROBIAL_SHROUD = RawBuffId.AmorphousArmorcloud
36    INFESTOR_NEURAL_PARASITE = RawBuffId.NeuralParasite
37    INHIBITOR_ZONE = RawBuffId.InhibitorZoneTemporalField
38    INHIBITOR_ZONE_FLYING = RawBuffId.InhibitorZoneFlyingTemporalField
39    LURKER_HOLD_FIRE = RawBuffId.LurkerHoldFireB
40    MARAUDER_CONCUSSIVE_SHELLS_SLOW = RawBuffId.Slow
41    MARAUDER_STIMMED = RawBuffId.StimpackMarauder
42    MARINE_STIMMED = RawBuffId.Stimpack
43    MEDIVAC_BOOST = RawBuffId.MedivacSpeedBoost
44    MOTHERSHIP_CLOAK_FIELD = RawBuffId.CloakField  # on the mothership
45    MOTHERSHIP_CLOAK_FIELD_CLOAKED = RawBuffId.CloakFieldEffect  # on each unit the field cloaks
46    MOTHERSHIP_TIME_WARP = RawBuffId.TemporalField
47    NEXUS_CHRONO_BOOST = RawBuffId.ChronoBoostEnergyCost
48    ORACLE_PULSAR_BEAM = RawBuffId.OracleWeapon
49    ORACLE_REVELATION = RawBuffId.OracleRevelation
50    ORBITAL_COMMAND_SUPPLY_DROP = RawBuffId.SupplyDrop
51    OVERSEER_CONTAMINATED = RawBuffId.Contaminated
52    PHOENIX_GRAVITON_BEAM = RawBuffId.GravitonBeam
53    QUEEN_INJECTED = RawBuffId.QueenSpawnLarvaTimer  # counts down to the larvae, then again for a queued inject
54    QUEEN_TRANSFUSED = RawBuffId.Transfusion
55    RAVEN_ANTI_ARMOR_MISSILE = RawBuffId.RavenShredderMissileArmorReductionUISubtruct
56    RAVEN_ANTI_ARMOR_MISSILE_INCOMING = RawBuffId.RavenShredderMissileTint  # on its target, until the missile lands
57    RAVEN_INTERFERENCE_MATRIX = RawBuffId.RavenScramblerMissile
58    SENTRY_GUARDIAN_SHIELD = RawBuffId.GuardianShield
59    STASIS_WARD_TRAPPED = RawBuffId.OracleStasisTrapTarget  # on each unit the ward traps, never on the ward (in game)
60    VIPER_BLINDING_CLOUD = RawBuffId.BlindingCloud
61    VIPER_PARASITIC_BOMB = RawBuffId.ParasiticBomb  # on its target
62    VOID_RAY_PRISMATIC_ALIGNMENT = RawBuffId.VoidRaySwarmDamageBoost
63    WARP_GATE_WARPING_IN = RawBuffId.PowerUserWarpable  # on a unit warping in, until the step after it finishes
64    ZEALOT_CHARGING = RawBuffId.Charging  # on the zealot
65
66    # Each race's worker carries gas under a game id of its own (in game).
67    _REMAPPED_IDS = nonmember(
68        MappingProxyType(
69            {
70                RawBuffId.CarryHarvestableVespeneGeyserGas: CARRYING_GAS,
71                RawBuffId.CarryHarvestableVespeneGeyserGasProtoss: CARRYING_GAS,
72                RawBuffId.CarryHarvestableVespeneGeyserGasZerg: CARRYING_GAS,
73            }
74        )
75    )
76    # Every unit of one type wears each of these for as long as it is listed, so it says nothing the type does not
77    # (in game).
78    _SKIPPED_IDS = nonmember(
79        frozenset(
80            {
81                RawBuffId.ParasiticBombUnitKU,  # by `UnitTypeId.PARASITIC_BOMB_LEFT_BEHIND`
82                RawBuffId.ParasiticBombSecondaryUnitSearch,  # by `UnitTypeId.PARASITIC_BOMB_LEFT_BEHIND`
83            }
84        )
85    )
86    """Game ids that are no member's own and that a unit's buffs and the buff events pass over."""

Buff ids used in multiplayer games.

ACCELERATION_ZONE = <BuffId.ACCELERATION_ZONE: 289>
ACCELERATION_ZONE_FLYING = <BuffId.ACCELERATION_ZONE_FLYING: 290>
BANSHEE_CLOAK = <BuffId.BANSHEE_CLOAK: 7>
CARRYING_GAS = <BuffId.CARRYING_GAS: 1000000>
CARRYING_MINERALS = <BuffId.CARRYING_MINERALS: 271>
CARRYING_MINERALS_RICH = <BuffId.CARRYING_MINERALS_RICH: 272>
CYCLONE_LOCKED_ON = <BuffId.CYCLONE_LOCKED_ON: 116>
GHOST_CLOAK = <BuffId.GHOST_CLOAK: 6>
GHOST_EMP_DECLOAK = <BuffId.GHOST_EMP_DECLOAK: 16>
GHOST_HOLD_FIRE = <BuffId.GHOST_HOLD_FIRE: 13>
GHOST_SNIPE = <BuffId.GHOST_SNIPE: 145>
HIGH_TEMPLAR_STORM = <BuffId.HIGH_TEMPLAR_STORM: 28>
HYDRALISK_LUNGE = <BuffId.HYDRALISK_LUNGE: 302>
IMMORTAL_BARRIER = <BuffId.IMMORTAL_BARRIER: 299>
INFESTOR_FUNGAL_GROWTH = <BuffId.INFESTOR_FUNGAL_GROWTH: 17>
INFESTOR_MICROBIAL_SHROUD = <BuffId.INFESTOR_MICROBIAL_SHROUD: 297>
INFESTOR_NEURAL_PARASITE = <BuffId.INFESTOR_NEURAL_PARASITE: 22>
INHIBITOR_ZONE = <BuffId.INHIBITOR_ZONE: 293>
INHIBITOR_ZONE_FLYING = <BuffId.INHIBITOR_ZONE_FLYING: 291>
LURKER_HOLD_FIRE = <BuffId.LURKER_HOLD_FIRE: 137>
MARAUDER_CONCUSSIVE_SHELLS_SLOW = <BuffId.MARAUDER_CONCUSSIVE_SHELLS_SLOW: 33>
MARAUDER_STIMMED = <BuffId.MARAUDER_STIMMED: 24>
MARINE_STIMMED = <BuffId.MARINE_STIMMED: 27>
MEDIVAC_BOOST = <BuffId.MEDIVAC_BOOST: 89>
MOTHERSHIP_CLOAK_FIELD = <BuffId.MOTHERSHIP_CLOAK_FIELD: 294>
MOTHERSHIP_CLOAK_FIELD_CLOAKED = <BuffId.MOTHERSHIP_CLOAK_FIELD_CLOAKED: 29>
MOTHERSHIP_TIME_WARP = <BuffId.MOTHERSHIP_TIME_WARP: 121>
NEXUS_CHRONO_BOOST = <BuffId.NEXUS_CHRONO_BOOST: 281>
ORACLE_PULSAR_BEAM = <BuffId.ORACLE_PULSAR_BEAM: 99>
ORACLE_REVELATION = <BuffId.ORACLE_REVELATION: 49>
ORBITAL_COMMAND_SUPPLY_DROP = <BuffId.ORBITAL_COMMAND_SUPPLY_DROP: 25>
OVERSEER_CONTAMINATED = <BuffId.OVERSEER_CONTAMINATED: 36>
PHOENIX_GRAVITON_BEAM = <BuffId.PHOENIX_GRAVITON_BEAM: 5>
QUEEN_INJECTED = <BuffId.QUEEN_INJECTED: 11>
QUEEN_TRANSFUSED = <BuffId.QUEEN_TRANSFUSED: 288>
RAVEN_ANTI_ARMOR_MISSILE = <BuffId.RAVEN_ANTI_ARMOR_MISSILE: 298>
RAVEN_ANTI_ARMOR_MISSILE_INCOMING = <BuffId.RAVEN_ANTI_ARMOR_MISSILE_INCOMING: 279>
RAVEN_INTERFERENCE_MATRIX = <BuffId.RAVEN_INTERFERENCE_MATRIX: 277>
SENTRY_GUARDIAN_SHIELD = <BuffId.SENTRY_GUARDIAN_SHIELD: 18>
STASIS_WARD_TRAPPED = <BuffId.STASIS_WARD_TRAPPED: 129>
VIPER_BLINDING_CLOUD = <BuffId.VIPER_BLINDING_CLOUD: 83>
VIPER_PARASITIC_BOMB = <BuffId.VIPER_PARASITIC_BOMB: 132>
VOID_RAY_PRISMATIC_ALIGNMENT = <BuffId.VOID_RAY_PRISMATIC_ALIGNMENT: 122>
WARP_GATE_WARPING_IN = <BuffId.WARP_GATE_WARPING_IN: 8>
ZEALOT_CHARGING = <BuffId.ZEALOT_CHARGING: 30>