Initial pass at PTR 2.1 support.

Author: GraylinKim

sc2reader/events/tracker.py

@@ -19,12 +19,30 @@ def load_context(self, replay):
         pass
 
     def _str_prefix(self):
-        return "{0}\t ".format(Length(seconds=int(self.frame/16)))
+        return "{0}\t ".format(Length(seconds=int(self.frame / 16)))
 
     def __str__(self):
         return self._str_prefix() + self.name
 
 
+class PlayerSetupEvent(TrackerEvent):
+    """ Sent during game setup to help us organize players better """
+    def __init__(self, frames, data, build):
+        super(PlayerSetupEvent, self).__init__(frames)
+
+        #: The player id of the player we are setting up
+        self.pid = data[0]
+
+        #: The type of this player. One of 1=human, 2=cpu, 3=neutral, 4=hostile
+        self.type = data[1]
+
+        #: The user id of the player we are setting up. None of not human
+        self.uid = data[2]
+
+        #: The slot id of the player we are setting up. None if not playing
+        self.sid = data[3]
+
+
 class PlayerStatsEvent(TrackerEvent):
     """
         Player Stats events are generated for all players that were in the game
@@ -178,10 +196,10 @@ def __init__(self, frames, data, build):
         self.resources_killed = self.minerals_killed + self.vespene_killed
 
         #: The food supply currently used
-        self.food_used = clamp(self.stats[29])/4096.0
+        self.food_used = clamp(self.stats[29]) / 4096.0
 
         #: The food supply currently available
-        self.food_made = clamp(self.stats[30])/4096.0
+        self.food_made = clamp(self.stats[30]) / 4096.0
 
         #: The total mineral value of all active forces
         self.minerals_used_active_forces = clamp(self.stats[31])
@@ -208,7 +226,7 @@ def __init__(self, frames, data, build):
         self.ff_vespene_lost_technology = clamp(self.stats[38]) if build >= 26490 else None
 
     def __str__(self):
-        return self._str_prefix()+"{0: >15} - Stats Update".format(self.player)
+        return self._str_prefix() + "{0: >15} - Stats Update".format(self.player)
 
 
 class UnitBornEvent(TrackerEvent):
@@ -256,17 +274,24 @@ def __init__(self, frames, data, build):
         #: The player object that controls this unit. 0 means neutral unit
         self.unit_controller = None
 
-        #: The x coordinate of the location
-        self.x = data[5] * 4
+        #: The x coordinate of the center of the born unit's footprint. Only 4 point resolution
+        #: prior to Starcraft Patch 2.1.
+        self.x = data[5]
 
-        #: The y coordinate of the location
-        self.y = data[6] * 4
+        #: The y coordinate of the center of the born unit's footprint. Only 4 point resolution
+        #: prior to Starcraft Patch 2.1.
+        self.y = data[6]
 
         #: The map location of the unit birth
         self.location = (self.x, self.y)
 
+        if build < 27950:
+            self.x = self.x * 4
+            self.y = self.y * 4
+            self.location = (self.x, self.y)
+
     def __str__(self):
-        return self._str_prefix()+"{0: >15} - Unit born {1}".format(self.unit_upkeeper, self.unit)
+        return self._str_prefix() + "{0: >15} - Unit born {1}".format(self.unit_upkeeper, self.unit)
 
 
 class UnitDiedEvent(TrackerEvent):
@@ -298,17 +323,39 @@ def __init__(self, frames, data, build):
         #: The player object of the that killed the unit. Not always available.
         self.killer = None
 
-        #: The x coordinate of the location
-        self.x = data[3] * 4
+        #: The x coordinate of the center of the dying unit's footprint. Only 4 point resolution
+        #: prior to Starcraft Patch 2.1.
+        self.x = data[3]
 
-        #: The y coordinate of the location
-        self.y = data[4] * 4
+        #: The y coordinate of the center of the dying unit's footprint. Only 4 point resolution
+        #: prior to Starcraft Patch 2.1.
+        self.y = data[4]
 
         #: The map location the unit was killed at.
         self.location = (self.x, self.y)
 
+        #: The index portion of the killing unit's id. Available for build 27950+
+        self.killer_unit_index = None
+
+        #: The recycle portion of the killing unit's id. Available for build 27950+
+        self.killer_unit_recycle = None
+
+        #: The unique id of the unit doing the killing. Available for build 27950+
+        self.killer_unit_id = None
+
+        if build < 27950:
+            self.x = self.x * 4
+            self.y = self.y * 4
+            self.location = (self.x, self.y)
+        else:
+            # Starcraft patch 2.1 introduced killer unit indexes
+            self.killer_unit_index = data[5]
+            self.killer_unit_recycle = data[6]
+            if self.killer_unit_index:
+                self.killer_unit_id = self.killer_unit_index << 18 | self.killer_unit_recycle
+
     def __str__(self):
-        return self._str_prefix()+"{0: >15} - Unit died {1}.".format(self.unit.owner, self.unit)
+        return self._str_prefix() + "{0: >15} - Unit died {1}.".format(self.unit.owner, self.unit)
 
 
 class UnitOwnerChangeEvent(TrackerEvent):
@@ -342,7 +389,7 @@ def __init__(self, frames, data, build):
         self.unit_controller = None
 
     def __str__(self):
-        return self._str_prefix()+"{0: >15} took {1}".format(self.unit_upkeeper, self.unit)
+        return self._str_prefix() + "{0: >15} took {1}".format(self.unit_upkeeper, self.unit)
 
 
 class UnitTypeChangeEvent(TrackerEvent):
@@ -367,7 +414,7 @@ def __init__(self, frames, data, build):
         self.unit_type_name = data[2].decode('utf8')
 
     def __str__(self):
-        return self._str_prefix()+"{0: >15} - Unit {0} type changed to {1}".format(self.unit.owner, self.unit, self.unit_type_name)
+        return self._str_prefix() + "{0: >15} - Unit {0} type changed to {1}".format(self.unit.owner, self.unit, self.unit_type_name)
 
 
 class UpgradeCompleteEvent(TrackerEvent):
@@ -389,7 +436,7 @@ def __init__(self, frames, data, build):
         self.count = data[2]
 
     def __str__(self):
-        return self._str_prefix()+"{0: >15} - {1}upgrade completed".format(self.player, self.upgrade_type_name)
+        return self._str_prefix() + "{0: >15} - {1}upgrade completed".format(self.player, self.upgrade_type_name)
 
 
 class UnitInitEvent(TrackerEvent):
@@ -432,17 +479,24 @@ def __init__(self, frames, data, build):
         #: The player object that controls this unit. 0 means neutral unit
         self.unit_controller = None
 
-        #: The x coordinate of the location
-        self.x = data[5] * 4
+        #: The x coordinate of the center of the init unit's footprint. Only 4 point resolution
+        #: prior to Starcraft Patch 2.1.
+        self.x = data[5]
 
-        #: The y coordinate of the location
-        self.y = data[6] * 4
+        #: The y coordinate of the center of the init unit's footprint. Only 4 point resolution
+        #: prior to Starcraft Patch 2.1.
+        self.y = data[6]
 
         #: The map location the unit was started at
         self.location = (self.x, self.y)
 
+        if build < 27950:
+            self.x = self.x * 4
+            self.y = self.y * 4
+            self.location = (self.x, self.y)
+
     def __str__(self):
-        return self._str_prefix()+"{0: >15} - Unit initiated {1}".format(self.unit_upkeeper, self.unit)
+        return self._str_prefix() + "{0: >15} - Unit initiated {1}".format(self.unit_upkeeper, self.unit)
 
 
 class UnitDoneEvent(TrackerEvent):
@@ -470,7 +524,7 @@ def __init__(self, frames, data, build):
         self.unit = None
 
     def __str__(self):
-        return self._str_prefix()+"{0: >15} - Unit {1} done".format(self.unit.owner, self.unit)
+        return self._str_prefix() + "{0: >15} - Unit {1} done".format(self.unit.owner, self.unit)
 
 
 class UnitPositionsEvent(TrackerEvent):
@@ -488,15 +542,20 @@ def __init__(self, frames, data, build):
         #: A dict mapping of units that had their position updated to their positions
         self.units = dict()
 
-        #: A list of (unit_index, (x,y)) derived from the first_unit_index and items
+        #: A list of (unit_index, (x,y)) derived from the first_unit_index and items. Prior to
+        #: Starcraft Patch 2.1 the coordinates have 4 point resolution. (15,25) recorded as (12,24).
+        #: Location prior to any rounding marks the center of the unit footprint.
         self.positions = list()
 
         unit_index = self.first_unit_index
         for i in range(0, len(self.items), 3):
             unit_index += self.items[i]
-            x = self.items[i+1]*4
-            y = self.items[i+2]*4
+            x = self.items[i + 1]
+            y = self.items[i + 2]
+            if build < 27950:
+                x = x * 4
+                y = y * 4
             self.positions.append((unit_index, (x, y)))
 
     def __str__(self):
-        return self._str_prefix()+"Unit positions update"
+        return self._str_prefix() + "Unit positions update"

sc2reader/readers.py

@@ -19,6 +19,7 @@ def __call__(self, data, replay):
             user_initial_data=[dict(
                 name=data.read_aligned_string(data.read_uint8()),
                 clan_tag=data.read_aligned_string(data.read_uint8()) if replay.base_build >= 24764 and data.read_bool() else None,
+                clan_logo=data.read_aligned_string(40) if replay.base_build >= 27950 and data.read_bool() else None,
                 highest_league=data.read_uint8() if replay.base_build >= 24764 and data.read_bool() else None,
                 combined_race_levels=data.read_uint32() if replay.base_build >= 24764 and data.read_bool() else None,
                 random_seed=data.read_uint32(),
@@ -74,6 +75,7 @@ def __call__(self, data, replay):
                 default_difficulty=data.read_bits(6),
                 default_ai_build=data.read_bits(7) if replay.base_build >= 23925 else None,
                 cache_handles=[DepotFile(data.read_aligned_bytes(40)) for i in range(data.read_bits(6 if replay.base_build >= 21955 else 4))],
+                has_extension_mod=data.read_bool() if replay.base_build >= 27950 else None,
                 is_blizzardMap=data.read_bool(),
                 is_premade_ffa=data.read_bool(),
                 is_coop_mode=data.read_bool() if replay.base_build >= 23925 else None,
@@ -610,6 +612,7 @@ def camera_update_event(self, data):
             distance=data.read_uint16() if data.read_bool() else None,
             pitch=data.read_uint16() if data.read_bool() else None,
             yaw=data.read_uint16() if data.read_bool() else None,
+            reason=None,
         )
 
     def trigger_abort_mission_event(self, data):
@@ -1361,6 +1364,7 @@ def hijack_replay_game_event(self, data):
                 name=data.read_aligned_string(data.read_uint8()),
                 toon_handle=data.read_aligned_string(data.read_bits(7)) if data.read_bool() else None,
                 clan_tag=data.read_aligned_string(data.read_uint8()) if data.read_bool() else None,
+                clan_logo=None,
             ) for i in range(data.read_bits(5))],
             method=data.read_bits(1),
         )
@@ -1381,6 +1385,7 @@ def game_user_join_event(self, data):
             name=data.read_aligned_string(data.read_bits(8)),
             toon_handle=data.read_aligned_string(data.read_bits(7)) if data.read_bool() else None,
             clan_tag=data.read_aligned_string(data.read_uint8()) if data.read_bool() else None,
+            clan_log=None,
         )
 
 
@@ -1430,6 +1435,43 @@ def trigger_mouse_moved_event(self, data):
         )
 
 
+class GameEventsReader_27950(GameEventsReader_26490):
+
+    def hijack_replay_game_event(self, data):
+        return dict(
+            user_infos=[dict(
+                game_user_id=data.read_bits(4),
+                observe=data.read_bits(2),
+                name=data.read_aligned_string(data.read_uint8()),
+                toon_handle=data.read_aligned_string(data.read_bits(7)) if data.read_bool() else None,
+                clan_tag=data.read_aligned_string(data.read_uint8()) if data.read_bool() else None,
+                clan_logo=data.read_aligned_string(40) if data.read_bool() else None,
+            ) for i in range(data.read_bits(5))],
+            method=data.read_bits(1),
+        )
+
+    def camera_update_event(self, data):
+        return dict(
+            target=dict(
+                x=data.read_uint16(),
+                y=data.read_uint16(),
+            ),
+            distance=data.read_uint16() if data.read_bool() else None,
+            pitch=data.read_uint16() if data.read_bool() else None,
+            yaw=data.read_uint16() if data.read_bool() else None,
+            reason=data.read_uint8() - 128 if data.read_bool() else None,
+        )
+
+    def game_user_join_event(self, data):
+        return dict(
+            observe=data.read_bits(2),
+            name=data.read_aligned_string(data.read_bits(8)),
+            toon_handle=data.read_aligned_string(data.read_bits(7)) if data.read_bool() else None,
+            clan_tag=data.read_aligned_string(data.read_uint8()) if data.read_bool() else None,
+            clan_logo=data.read_aligned_string(40) if data.read_bool() else None,
+        )
+
+
 class TrackerEventsReader(object):
 
     def __init__(self):
@@ -1443,6 +1485,7 @@ def __init__(self):
             6: UnitInitEvent,
             7: UnitDoneEvent,
             8: UnitPositionsEvent,
+            9: PlayerSetupEvent,
         }
 
     def __call__(self, data, replay):

sc2reader/resources.py

@@ -553,10 +553,10 @@ def register_default_readers(self):
         self.register_reader('replay.game.events', readers.GameEventsReader_22612(), lambda r: 22612 <= r.base_build < 23260)
         self.register_reader('replay.game.events', readers.GameEventsReader_23260(), lambda r: 23260 <= r.base_build < 24247)
         self.register_reader('replay.game.events', readers.GameEventsReader_24247(), lambda r: 24247 <= r.base_build < 26490)
-        self.register_reader('replay.game.events', readers.GameEventsReader_26490(), lambda r: 26490 <= r.base_build)
+        self.register_reader('replay.game.events', readers.GameEventsReader_26490(), lambda r: 26490 <= r.base_build < 27950)
+        self.register_reader('replay.game.events', readers.GameEventsReader_27950(), lambda r: 27950 <= r.base_build)
         self.register_reader('replay.game.events', readers.GameEventsReader_HotSBeta(), lambda r: r.versions[1] == 2 and r.build < 24247)
 
-
     def register_default_datapacks(self):
         """Registers factory default datapacks."""
         self.register_datapack(datapacks['WoL']['16117'], lambda r: r.expansion == 'WoL' and 16117 <= r.build < 17326)