Merged pull request #14 from grom358/obslibmerge.

Modified read_coordinate to return the x,y coordinate pair as floats
Minor improvements to data.py and the ability event interface.

Author: GraylinKim

sc2reader/data.py

@@ -126,6 +126,10 @@ class GameObject(object):
     @classmethod
     def get_type(cls, code):
         return OBJECTTYPE_CODES[code]
+        
+    @classmethod
+    def get_ability(cls, code):
+        return ABILITIES[code]
 
     @classmethod
     def has_type(cls, code):
@@ -1245,8 +1249,10 @@ class RichVespeneGeyser(GameObject):
 # The following mineral field and vespene geyser codes were found on the 'Agria Valley' map
 class MineralField2(GameObject):
     code = 0xf801
+    name = 'Mineral Field'
 class VespeneGeyser2(GameObject):
     code = 0xf901
+    name = 'Vespene Geyser'
 
 class XelnagaTower(GameObject):
     code = 0xad01

sc2reader/objects.py

@@ -244,12 +244,13 @@ def apply(self):
             if self.ability not in ABILITIES:
                 print "Unknown ability (%s) in frame %s" % (hex(self.ability),self.frame)
                 #raise ValueError("Unknown ability (%s)" % (hex(self.ability)),)
-            ability = ABILITIES[self.ability]
-            able = self.get_able_selection(ability)
-            if able:
-                object = able[0]
-                ability = getattr(object, ability)
-                ability(self.frame)
+            else:
+                ability = ABILITIES[self.ability]
+                able = self.get_able_selection(ability)
+                if able:
+                    object = able[0]
+                    ability = getattr(object, ability)
+                    ability(self.frame)
 
         # claim units
         for obj in self.player.get_selection().current:

sc2reader/parsers.py

@@ -35,7 +35,7 @@ def parse_ability_event(self, buffer, frames, type, code, pid):
 
                 if ability_flags & 0x10:
                     # ability(3), coordinates (4), ?? (4)
-                    location = (buffer.read_coordinate(), buffer.read_coordinate())
+                    location = buffer.read_coordinate()
                     buffer.skip(4)
                     return LocationAbilityEvent(frames, pid, type, code, ability, location)
 
@@ -53,7 +53,7 @@ def parse_ability_event(self, buffer, frames, type, code, pid):
 
         elif atype & 0x40: # location/move
             # coordinates (4), ?? (6)
-            location = (buffer.read_coordinate(), buffer.read_coordinate())
+            location = buffer.read_coordinate()
             buffer.skip(5)
             return LocationAbilityEvent(frames, pid, type, code, ability, location)
 

sc2reader/utils.py

@@ -68,6 +68,7 @@ def __init__(self, file):
         self.lo_masks_inv = [0x00, 0x80, 0xC0, 0xE0, 0xF0, 0xF8, 0xFC, 0xFE, 0xFF]
         self.hi_masks = [0xFF ^ mask for mask in self.lo_masks]
         self.hi_masks_inv = [0xFF ^ mask for mask in self.lo_masks_inv]
+        self.coord_convert = [(2**(12 - i),1.0/2**i) for i in range(1,13)]
 
         self.read_basic = self.io.read
     '''
@@ -215,9 +216,22 @@ def read_object_id(self):
         """ Object ID is big-endian int32 """
         return self.read_int(endian=BIG_ENDIAN)
 
-    def read_coordinate(self):
-        coord = self.read(bits=20)
-        return [coord[0], coord[1] << 4 | coord[2],]
+    def read_coordinate(self):        
+        # Combine coordinate whole and fraction
+        def _coord_to_float(coord):
+            fraction = 0
+            for mask,quotient in self.coord_convert:
+                if (coord[1] & mask):
+                    fraction = fraction + quotient
+            return coord[0] + fraction
+        
+        # Read an x or y coordinate dimension
+        def _coord_dimension():
+            coord = self.read(bits=20)
+            return _coord_to_float([coord[0], coord[1] << 4 | coord[2],])
+        
+        # TODO?: Handle optional z dimension
+        return (_coord_dimension(), _coord_dimension())
 
     def read_bitmask(self):
         """ Reads a bitmask given the current bitoffset """