Ignore:
Timestamp:
10/17/09 02:05:35 (10 years ago)
Author:
Kaydeth_parpg
Message:

Ticket #2: Patch by Kaydeth. Updated the classes in local_loaders and utilities directories to correct some obvious discrepancies with our coding standard. comment[s:trac, t:2] fixes[s:trac, t:2]

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/game/utilities/transition.py

    r147 r328  
    103103                sys.exit(False) 
    104104            # start a new layer 
    105             self.layers.append(XMLLayerData(x,y,name)) 
     105            self.layers.append(XMLLayerData(x, y, name)) 
    106106            self.current_layer = True 
    107107        elif(name == "i"): 
     
    130130            self.layers[-1].tiles.append(XMLTileData(x, y, z, o, i)) 
    131131 
    132     def endElement(self,name): 
     132    def endElement(self, name): 
    133133        if(name == "layer"): 
    134134            # end of current layer 
     
    145145        self.max_y = 0 
    146146 
    147     def OutputTransLayer(self, l_file, l_count): 
     147    def outputTransLayer(self, l_file, l_count): 
    148148        if(len(self.render_tiles) == 0): 
    149149            return True 
    150150        try: 
    151             layer_name="TransitionLayer"+str(l_count) 
     151            layer_name = "TransitionLayer" + str(l_count) 
    152152            l_file.write('''    <layer x_offset="0.0" pathing="''') 
    153153            l_file.write('''cell_edges_and_diagonals" y_offset="0.0"''') 
    154154            l_file.write(''' grid_type="square" id="''') 
    155             l_file.write(layer_name+'''"''') 
     155            l_file.write(layer_name + '''"''') 
    156156            l_file.write(''' x_scale="1" y_scale="1" rotation="0.0">\n''') 
    157157            l_file.write('        <instances>\n') 
     
    170170        return True 
    171171 
    172     def GetSurroundings(self,x,y,search): 
    173         """Function called by BuildTransLayer to see if a tile needs to 
     172    def GetSurroundings(self, x, y, search): 
     173        """Function called by buildTransLayer to see if a tile needs to 
    174174           display transition graphics over it (drawn on another layer)""" 
    175175        # check all of the tiles around the current tile 
    176176        value=0 
    177         if(self.PMatchSearch(x,y+1,search) == True): 
     177        if(self.pMatchSearch(x,y+1,search) == True): 
    178178            value += RIGHT 
    179         if(self.PMatchSearch(x-1,y+1,search) == True): 
     179        if(self.pMatchSearch(x-1,y+1,search) == True): 
    180180            value += BOTTOM_RIGHT 
    181         if(self.PMatchSearch(x-1,y,search) == True): 
     181        if(self.pMatchSearch(x-1,y,search) == True): 
    182182            value += BOTTOM 
    183         if(self.PMatchSearch(x-1,y-1,search) == True): 
     183        if(self.pMatchSearch(x-1,y-1,search) == True): 
    184184            value += BOTTOM_LEFT 
    185         if(self.PMatchSearch(x,y-1,search) == True): 
     185        if(self.pMatchSearch(x,y-1,search) == True): 
    186186            value += LEFT 
    187         if(self.PMatchSearch(x+1,y-1,search) == True): 
     187        if(self.pMatchSearch(x+1,y-1,search) == True): 
    188188            value += TOP_LEFT 
    189         if(self.PMatchSearch(x+1,y,search) == True): 
     189        if(self.pMatchSearch(x+1,y,search) == True): 
    190190            value += TOP 
    191         if(self.PMatchSearch(x+1,y+1,search) == True): 
     191        if(self.pMatchSearch(x+1,y+1,search) == True): 
    192192            value += TOP_RIGHT 
    193193        return value 
    194194 
    195     def GetTransitionTiles(self, search): 
     195    def getTransitionTiles(self, search): 
    196196        """Build up and return a list of the tiles that might 
    197197           need a transition tiles layed over them""" 
     
    204204                # whereas now we we need to check all the tiles around 
    205205                # this tile 
    206                 trans_value = self.GetSurroundings(t.x,t.y,search) 
     206                trans_value = self.GetSurroundings(t.x, t.y, search) 
    207207                if(trans_value != 0): 
    208208                    # we found an actual real transition 
     
    210210        return tiles 
    211211 
    212     def GetTransitionName(self, base, value, corner=False): 
     212    def getTransitionName(self, base, value, corner=False): 
    213213        if(corner == False): 
    214             name = base+"-ts" 
     214            name = base + "-ts" 
    215215        else: 
    216             name = base+"-tc" 
     216            name = base + "-tc" 
    217217        if(value < 10): 
    218218            name += "0" 
    219         name+=str(value) 
     219        name += str(value) 
    220220        return name 
    221221 
    222     def BuildTransLayer(self, search): 
     222    def buildTransLayer(self, search): 
    223223        """Build up the data for a transition layer 
    224224           search is the string that matches the start of the name of 
    225225           each tile that we are looking for""" 
    226         transition_tiles = self.GetTransitionTiles(search)        
     226        transition_tiles = self.getTransitionTiles(search)        
    227227        # now we have all the possible tiles, lets see what they 
    228228        # actually need to have rendered 
     
    237237                    # we must add a corner piece as well 
    238238                    corners = corners/16 
    239                     name = self.GetTransitionName(search, corners, True) 
     239                    name = self.getTransitionName(search, corners, True) 
    240240                    self.ttiles.append(XMLTileData(t[0], t[1], 0, name)) 
    241241                # add the side tile pieces 
    242                 name = self.GetTransitionName(search, sides, False) 
     242                name = self.getTransitionName(search, sides, False) 
    243243                self.ttiles.append(XMLTileData(t[0], t[1], 0, name)) 
    244244            else: 
     
    248248                if(corners != 0): 
    249249                    # there is a corner piece needed 
    250                     name = self.GetTransitionName(search, corners, True) 
     250                    name = self.getTransitionName(search, corners, True) 
    251251                    self.ttiles.append(XMLTileData(t[0], t[1], 0, name)) 
    252252 
    253     def LoadFromXML(self, filename): 
     253    def loadFromXML(self, filename): 
    254254        """Load a map from the XML file used in Fife 
    255255           Returns True if it worked, False otherwise""" 
     
    261261        # now open and read the XML file 
    262262        parser = make_parser() 
    263         curHandler = LocalXMLParser() 
    264         parser.setContentHandler(curHandler) 
     263        cur_handler = LocalXMLParser() 
     264        parser.setContentHandler(cur_handler) 
    265265        parser.parse(map_file) 
    266266        map_file.close() 
    267267        # make a copy of the layer data 
    268         self.layers = curHandler.layers 
     268        self.layers = cur_handler.layers 
    269269        return True 
    270270     
    271     def GetSize(self): 
    272         """GetSize stores the size of the grid""" 
     271    def getSize(self): 
     272        """getSize stores the size of the grid""" 
    273273        for t in self.layers[0].tiles: 
    274274            if t.x > self.max_x: 
     
    281281                self.min_y = t.y 
    282282     
    283     def CheckRange(self, x, y): 
     283    def checkRange(self, x, y): 
    284284        """Grid co-ords in range?""" 
    285         if((x < self.min_x)or(x > self.max_x)or 
    286            (y < self.min_y)or(y > self.max_y)): 
     285        if((x < self.min_x) or (x > self.max_x) or 
     286           (y < self.min_y) or (y > self.max_y)): 
    287287           return False 
    288288        return True 
    289289 
    290     def PMatchSearch(self, x, y, search): 
     290    def pMatchSearch(self, x, y, search): 
    291291        """Brute force method used for matching grid""" 
    292292        # is the tile even in range? 
    293         if(self.CheckRange(x,y) == False): 
     293        if(self.checkRange(x, y) == False): 
    294294            return False 
    295295        size = len(search) 
    296296        for t in self.layers[0].tiles: 
    297             if((t.x == x)and(t.y == y)and(t.object[:size] == search)): 
     297            if((t.x == x) and (t.y == y) and (t.object[:size] == search)): 
    298298                return(True) 
    299299        # no match 
    300300        return False 
    301301 
    302     def CoordsMatch(self, x, y, tiles): 
     302    def coordsMatch(self, x, y, tiles): 
    303303        """Helper routine to check wether the list of tiles 
    304304           in tiles has any contain the coords x,y""" 
    305305        for t in tiles: 
    306             if((t.x == x)and(t.y == y)): 
     306            if((t.x == x) and (t.y == y)): 
    307307                return True 
    308308        # obviously no match 
    309309        return False 
    310310 
    311     def SaveMap(self, filename): 
     311    def saveMap(self, filename): 
    312312        """Save the new map""" 
    313313        # open the new files for writing 
     
    325325            self.render_tiles = [] 
    326326            for t in self.ttiles: 
    327                 if(self.CoordsMatch(t.x, t.y, self.render_tiles) == False): 
     327                if(self.coordsMatch(t.x, t.y, self.render_tiles) == False): 
    328328                    # no matching tile in the grid so far, so add it 
    329329                    self.render_tiles.append(t) 
     
    332332                    recycled_tiles.append(t) 
    333333            # render this layer 
    334             if(self.OutputTransLayer(map_file,layer_count) == False): 
     334            if(self.outputTransLayer(map_file, layer_count) == False): 
    335335                return False 
    336336            layer_count += 1 
    337             self.ttiles=recycled_tiles 
     337            self.ttiles = recycled_tiles 
    338338        # phew, that was it 
    339339        map_file.close() 
    340340        print "Output new file as new.xml" 
    341         print "Had to render",layer_count,"layers" 
     341        print "Had to render", layer_count, "layers" 
    342342        return True 
    343343     
    344     def PrintDetails(self): 
     344    def printDetails(self): 
    345345        """Debugging routine to output some details about the map 
    346346           Used to check the map loaded ok""" 
     
    349349        for l in self.layers: 
    350350            print l.name, 
    351         print "\nMap Dimensions: X=",(self.max_x-self.min_x) + 1, 
    352         print " Y=",(self.max_y-self.min_y) + 1 
     351        print "\nMap Dimensions: X=", (self.max_x-self.min_x) + 1, 
     352        print " Y=", (self.max_y-self.min_y) + 1 
    353353 
    354354if __name__=="__main__": 
     
    357357        sys.stderr.write("Error: No map given!\n") 
    358358        sys.exit(False) 
    359     new_map=LocalMap() 
    360     if(new_map.LoadFromXML(sys.argv[1]) == True): 
    361         new_map.GetSize() 
    362         new_map.BuildTransLayer("grass") 
    363         new_map.SaveMap("new.xml") 
    364         new_map.PrintDetails() 
    365  
     359         
     360    new_map = LocalMap() 
     361    if(new_map.loadFromXML(sys.argv[1]) == True): 
     362        new_map.getSize() 
     363        new_map.buildTransLayer("grass") 
     364        new_map.saveMap("new.xml") 
     365        new_map.printDetails() 
     366 
Note: See TracChangeset for help on using the changeset viewer.