game_state.py

game_state.py#

class sc2.game_state.GameState(response_observation: ResponseObservation, previous_observation: ResponseObservation | None = None) → None[source]#
Parameters:

  • response_observation (ResponseObservation)

  • previous_observation (ResponseObservation | None)

property action_errors: list[ActionError][source]#

List of erroneous actions since last frame. See Blizzard/s2client-proto

property actions: list[ActionRawUnitCommand | ActionRawToggleAutocast | ActionRawCameraMove][source]#

List of successful actions since last frame. See Blizzard/s2client-proto

Each action is converted into Python dataclasses: ActionRawUnitCommand, ActionRawToggleAutocast, ActionRawCameraMove

property actions_toggle_autocast: list[ActionRawToggleAutocast][source]#

List of successful autocast toggle actions since last frame. See Blizzard/s2client-proto

property actions_unit_commands: list[ActionRawUnitCommand][source]#

List of successful unit actions since last frame. See Blizzard/s2client-proto

property alerts: list[int][source]#

Game alerts, see Blizzard/s2client-proto

property chat: list[ChatMessage][source]#

List of chat messages sent this frame (by either player).

property dead_units: set[int][source]#

A set of unit tags that died this frame

effects: set[EffectData]#

Usage: for effect in self.state.effects:

if effect.id == EffectId.RAVAGERCORROSIVEBILECP:

positions = effect.positions # dodge the ravager biles

class sc2.game_state.Blip(proto: Unit) → None[source]#
Parameters:

proto (Unit)

property is_blip: bool#

Detected by sensor tower.

property position: Point2#

2d position of the blip.

property position3d: Point3#

3d position of the blip.

class sc2.game_state.Common(proto: PlayerCommon) → None[source]#
Parameters:

proto (PlayerCommon)

class sc2.game_state.EffectData(proto: Effect | Unit, fake: bool = False) → None[source]#
Parameters:

  • proto (Effect | Unit)

  • fake (bool)

property is_enemy: bool#

Checks if the effect is hostile.

property is_mine: bool#

Checks if the effect is caused by me.

Contents