Changeset 476


Ignore:
Timestamp:
02/02/10 14:41:03 (10 years ago)
Author:
maximinus_parpg
Message:

Edited and tidied up files.
Generally a mix of spelling mistakes, non pep-8 code
and other things.

Location:
trunk/game/scripts
Files:
8 edited

Legend:

Unmodified
Added
Removed
  • trunk/game/scripts/console.py

    r448 r476  
    1414#   along with this program.  If not, see <http://www.gnu.org/licenses/>. 
    1515 
    16 import re  
     16import re 
    1717import os 
    1818 
    1919class Console: 
    2020    def __init__(self, app_listener): 
    21         """  
    22         Constructor 
     21        """ 
    2322        @type appListener: ApplicationListener 
    2423        @param appListener: ApplicationListener object providing a link with 
     
    5150 
    5251    def handleQuit(self, command): 
    53         """  
    54         Implements the quit console command  
    55         @type command: string 
    56         @param command: The command to run 
    57         @return: The resultstring""" 
    58          
     52        """Implements the quit console command  
     53           @type command: string 
     54           @param command: The command to run 
     55           @return: The resultstring""" 
    5956        self.app_listener.quitGame() 
    6057        return "Terminating ..." 
    6158 
    6259    def handlePause(self, command): 
    63         """ 
    64         Implements the pause console command 
    65         @type command: string 
    66         @param command: The command to run 
    67         @return: The resultstring""" 
    68          
     60        """Implements the pause console command 
     61           @type command: string 
     62           @param command: The command to run 
     63           @return: The resultstring""" 
    6964        self.world.togglePause() 
    7065        return "Game (un)paused" 
    7166     
    7267    def handleGrid(self, command): 
    73         """  
    74         Implements the grid console command  
    75         @type command: string 
    76         @param command: The command to run 
    77         @return: The resultstring""" 
    78  
     68        """Implements the grid console command  
     69           @type command: string 
     70           @param command: The command to run 
     71           @return: The resultstring""" 
    7972        self.app_listener.world.active_map.toggleRenderer('GridRenderer') 
    8073        return "Grid toggled" 
    8174 
    8275    def handleRun(self, command): 
    83         """ 
    84         Toggles run/walk mode of the PC player 
    85         @type command: string 
    86         @param command: The command to run. 
    87         @return: The response""" 
    88          
     76        """Toggles run/walk mode of the PC player 
     77           @type command: string 
     78           @param command: The command to run. 
     79           @return: The response""" 
    8980        if self.app_listener.model.pc_run == 1: 
    9081            self.app_listener.model.pc_run = 0 
     
    9485            return "PC is now running" 
    9586             
    96  
    9787    def handleHelp(self, command): 
    98         """  
    99         Implements the help console command  
    100         @type command: string 
    101         @param command: The command to run 
    102         @return: The resultstring""" 
    103  
    104         res="" 
     88        """Implements the help console command  
     89           @type command: string 
     90           @param command: The command to run 
     91           @return: The resultstring""" 
     92        res = "" 
    10593        for cmd in self.commands: 
    10694            res += "%10s: %s\n" % (cmd["cmd"], cmd["help"]) 
    107  
    10895        return res 
    10996 
    11097    def handlePython(self, command): 
    111         """  
    112         Implements the python console command  
    113         @type command: string 
    114         @param command: The command to run 
    115         @return: The resultstring""" 
    116  
     98        """Implements the python console command  
     99           @type command: string 
     100           @param command: The command to run 
     101           @return: The resultstring""" 
    117102        result = None 
    118103        python_regex = re.compile('^python') 
     
    128113 
    129114    def handleLoad(self, command): 
    130         """  
    131         Implements the load console command  
    132         @type command: string 
    133         @param command: The command to run 
    134         @return: The resultstring""" 
    135  
     115        """Implements the load console command  
     116           @type command: string 
     117           @param command: The command to run 
     118           @return: The resultstring""" 
    136119        result = None 
    137120        load_regex = re.compile('^load') 
     
    153136 
    154137    def handleSave(self, command): 
    155         """  
    156         Implements the save console command  
    157         @type command: string 
    158         @param command: The command to run 
    159         @return: The resultstring""" 
    160  
     138        """Implements the save console command  
     139           @type command: string 
     140           @param command: The command to run 
     141           @return: The resultstring""" 
    161142        save_regex = re.compile('^save') 
    162143        s_matches = save_regex.match(command.lower()) 
     
    178159 
    179160    def handleConsoleCommand(self, command): 
    180         """ 
    181         Implements the console logic  
    182         @type command: string 
    183         @param command: The command to run 
    184         @return: The response string """ 
    185  
     161        """Implements the console logic  
     162           @type command: string 
     163           @param command: The command to run 
     164           @return: The response string """ 
    186165        result = None         
    187166        for cmd in self.commands: 
     
    193172            result = "Invalid command, enter help for more information" 
    194173 
    195         return result  
    196  
    197                    
    198  
     174        return result 
  • trunk/game/scripts/dialoguevalidator.py

    r469 r476  
    2121 
    2222class DialogueFormatException(Exception): 
    23     """ Exception thrown when the DialogueValidator has encountered an  
    24     error. """ 
     23    """ Exception thrown when the DialogueValidator has encountered an error""" 
    2524    pass 
    2625 
    2726class DialogueValidator(object): 
    28  
    2927    def validateDialogue(self, tree, topdir): 
    30         """ Checks whether a given tree is containing a valid dialogue. 
    31         @type tree 
    32         @param tree 
    33         @type topdir: string 
    34         @param topdir: Top directory where to start searching for files. 
    35         @raises: dialogueFormatException on error 
    36         @return: true on success""" 
    37      
     28        """Checks whether a given tree is containing a valid dialogue. 
     29           @type tree 
     30           @param tree 
     31           @type topdir: string 
     32           @param topdir: Top directory where to start searching for files. 
     33           @raises: dialogueFormatException on error 
     34           @return: true on success""" 
    3835        self.tree = tree  
    3936        self.topdir = topdir 
    40          
     37 
    4138        # Test if the required top nodes are present 
    4239        for node in ("NPC", "AVATAR", "START"): 
     
    4542                raise DialogueFormatException("Node: " + node + \ 
    4643                                              " not found or invalid type") 
    47          
    48          
     44           
    4945        self.__validateAvatar() 
    5046 
     
    6662     
    6763    def validateDialogueFromFile(self, file_name, topdir="."): 
    68         """ Checks whether a yaml file is containing a valid dialogue  
    69         @type file_name: string  
    70         @param file_name: File name of the yaml file to validate 
    71         @type topdir: string 
    72         @param topdir: Top directory where to start searching for files. 
    73         @raises: DialogueFormatException on error 
    74         @return: True on success""" 
    75  
     64        """Checks whether a yaml file is containing a valid dialogue  
     65           @type file_name: string  
     66           @param file_name: File name of the yaml file to validate 
     67           @type topdir: string 
     68           @param topdir: Top directory where to start searching for files. 
     69           @raises: DialogueFormatException on error 
     70           @return: True on success""" 
    7671        tree = yaml.load(file(file_name)) 
    7772        return self.validateDialogue(tree, topdir) 
    7873 
    7974    def __validateAvatar(self): 
    80         """ Check that the avatar is an existing file.  
    81         @raises: DialogueFormatException on error. """ 
     75        """Check that the avatar is an existing file.  
     76           @raises: DialogueFormatException on error.""" 
    8277        fname = os.path.join(self.topdir,self.tree["AVATAR"]) 
    8378        if not os.path.isfile(fname): 
     
    8782         
    8883    def __validateSection(self, section, section_name): 
    89         """ Checks whether a section is a valid section. 
    90         @type section: dictionary 
    91         @type section_name: string 
    92         @param section: Section to validate 
    93         @param section_name: Name of the section to validate 
    94         @raises: DialogueFormatException on error """ 
    95  
     84        """Checks whether a section is a valid section. 
     85           @type section: dictionary 
     86           @type section_name: string 
     87           @param section: Section to validate 
     88           @param section_name: Name of the section to validate 
     89           @raises: DialogueFormatException on error """ 
    9690        for entry in section: 
     91            # TODO: This section is very repitive, could be coded better 
    9792            for action in entry: 
    9893                # Verify if the commands are known and if their parameters have 
     
    114109                            "Section: " + section_name + " has an invalid " +\ 
    115110                            action + " node") 
    116                     #TODO: verify person  
     111                #TODO: verify person  
    117112                elif action in ("complete_quest", "start_quest", \ 
    118113                                "delete_quest"): 
     
    121116                            "Section: " + section_name + " has an invalid " +\ 
    122117                            action + " node") 
    123                     #TODO: verify quest 
     118                #TODO: verify quest 
    124119                elif action in ("get_stuff", "give_stuff"): 
    125120                    if not isinstance(entry[action], types.StringType): 
     
    127122                            "Section: " + section_name + " has an invalid " +\ 
    128123                            action + " node") 
    129                     #TODO: verify object 
     124                #TODO: verify object 
    130125                elif action in ("increase_value", "decrease_value", \ 
    131126                                "set_value"): 
     
    134129                            "Section: " + section_name + " has an invalid " +\ 
    135130                            action + " node")                     
    136                     #TODO: verify value checks  
     131                #TODO: verify value checks  
    137132                elif action == "dialogue": 
    138133                    if not isinstance(entry[action], types.StringType) \ 
     
    141136                            "Section: " + section_name + " has an invalid " +\ 
    142137                            action + " node") 
    143                 else : 
     138                else: 
    144139                    raise DialogueFormatException("Section: " + section_name + \ 
    145140                                                  " has an unknown action: " +\ 
     
    148143 
    149144    def __validateResponses(self, responses, section_name): 
    150         """ Checks if the list of responses is a valid list. 
    151         @type responses: List 
    152         @param respones: A list of response 
    153         @type section_name: String 
    154         @param section_name: The section name these responses belong to 
    155         @raise DialogueFormatException on error  
    156         @return True When the lists is a valid list""" 
    157          
     145        """Checks if the list of responses is a valid list. 
     146           @type responses: List 
     147           @param respones: A list of response 
     148           @type section_name: String 
     149           @param section_name: The section name these responses belong to 
     150           @raise DialogueFormatException on error  
     151           @return True When the lists is a valid list""" 
    158152        for option in responses: 
    159153            if not isinstance(option[0], types.StringType): 
     
    164158                                              " contains an invalid target: " +\ 
    165159                                              option[1] + " in response") 
    166              
    167160            #TODO: option[2] might be a conditional  
    168161         
    169162    def __isValidSectionName(self, name): 
    170         """ Checks if a given name is valid section 
    171         @type name: string 
    172         @param name: Name of the section to check 
    173         @return True when name is a valid section name, False otherwise""" 
    174          
     163        """Checks if a given name is valid section 
     164           @type name: string 
     165           @param name: Name of the section to check 
     166           @return True when name is a valid section name, False otherwise""" 
    175167        if name=="back" or name=="end": 
    176168            return True 
    177169 
    178170        if name in self.tree["SECTIONS"]: 
    179             return True; 
     171            return True 
    180172 
    181173        # Handle 'back name' used to go back 'n' in the stack. 
    182174        if name.startswith("back "): 
    183             return self.__isValidSectionName(name.split(" ")[1]) 
    184          
    185         return False; 
    186  
     175            return self.__isValidSectionName(name.split(" ")[1])         
     176        return False 
  • trunk/game/scripts/engine.py

    r445 r476  
    103103            return 
    104104         
    105         #Remove all currently loaded maps so we can start fresh 
     105        # Remove all currently loaded maps so we can start fresh 
    106106        self.view.deleteMaps(); 
    107107         
     
    119119        self.game_state.PC.createBehaviour(self.view.active_map.agent_layer) 
    120120         
    121         #In most maps we'll create the PC Instance internally. In these 
    122         #cases we need a target position 
     121        # In most maps we'll create the PC Instance internally. In these 
     122        # cases we need a target position 
    123123        self.target_position = self.game_state.saved_pc_coordinates 
    124124         
    125         #Load the current map 
     125        # Load the current map 
    126126        if self.game_state.current_map_file: 
    127127            self.loadMap(self.game_state.current_map_name, \ 
     
    136136           @type instance: fife.Instance 
    137137           @param instance: FIFE instance corresponding to the object 
    138            @return: None 
    139         """ 
     138           @return: None""" 
    140139        # create the extra data 
    141140        extra = {} 
     
    148147            self.addPC(layer, obj, instance) 
    149148        else: 
    150             self.addObject(layer, obj, instance) 
    151  
    152          
     149            self.addObject(layer, obj, instance)  
    153150 
    154151    def addPC(self, layer, pc, instance): 
     
    160157           @type instance: fife.Instance 
    161158           @param instance: FIFE instance of PC 
    162            @return: None 
    163         """ 
     159           @return: None""" 
    164160        # For now we copy the PC, in the future we will need to copy 
    165161        # PC specifics between the different PC's 
     
    180176           @type instance: fife.Instance 
    181177           @param instance: FIFE instance of object 
    182            @return: None 
    183         """ 
    184  
     178           @return: None""" 
    185179        ref = self.game_state.getObjectById(obj.ID, \ 
    186180                                            self.game_state.current_map_name)  
     
    198192            # create the agent 
    199193            obj.setup() 
    200              
    201194            # create the PC agent 
    202195            obj.start() 
  • trunk/game/scripts/gamestate.py

    r432 r476  
    2222    """This class holds the current state of the game.""" 
    2323    def __init__(self): 
    24         """initialize attributes""" 
    2524        self.PC = None 
    2625        self.quest_engine = quest_engine.QuestEngine() 
     
    2827        self.current_map_file = None 
    2928        self.current_map_name = None 
    30         #these coordinates are only used for saving and loading the game. 
    31         #They do not represent the pc's active location 
     29        # these coordinates are only used for saving and loading the game. 
     30        # They do not represent the pc's active location 
    3231        self.saved_pc_coordinates = (0,0) 
    3332         
     
    3736           @param map: The map name. 
    3837           @returns: The list of objects on this map. Or an empty list""" 
    39          
    4038        if map_id in self.objects: 
    4139            return [i for i in self.objects[map_id].values() if map_id in self.objects] 
     
    5452        if obj_id in self.objects[map_id]: 
    5553            return self.objects[map_id][obj_id] 
    56          
  • trunk/game/scripts/inventory.py

    r449 r476  
    103103 
    104104    def findItem(self, **kwargs): 
    105         """Find an item in inventory by various attributes. All parameters are optional. 
     105        """Find an item in inventory by various attributes. All parameters  
     106           are optional. 
    106107           @type name: String 
    107            @param name: Unique or non-unique object name. If the name is non-unique, first matching object is returned 
     108           @param name: Object name. If the name is non-unique,  
     109                        first matching object is returned 
    108110           @type kind: String 
    109            @param kind: One of the possible object kinds like "openable" or "weapon" (see base.py) 
    110            @return: The item matching criteria or None if none was found 
    111         """ 
    112  
     111           @param kind: One of the possible object kinds like "openable" or  
     112                        "weapon" (see base.py) 
     113           @return: The item matching criteria or None if none was found""" 
    113114        for slot in self.items: 
    114115            item_found = self.items[slot].findItem(**kwargs) 
  • trunk/game/scripts/map.py

    r473 r476  
    2020from local_loaders.loaders import loadMapFile 
    2121from scripts.common.eventlistenerbase import EventListenerBase 
     22from settings import Setting 
    2223 
    23 from settings import Setting 
    2424TDS = Setting() 
    2525 
     
    151151        """Add the player character to the map 
    152152           @return: None""" 
    153  
    154153        # Update gamestate.PC 
    155154        self.data.game_state.PC.behaviour.onNewMap(self.agent_layer) 
  • trunk/game/scripts/quest_engine.py

    r350 r476  
    6464           @param value: the value you want to increase the variable with 
    6565           @return: True on success 
    66            @return: False when it failes""" 
     66           @return: False when it fails""" 
    6767        if self.quest_variables.has_key(variable_name): 
    6868            self.quest_variables[variable_name]["value"] += value 
     
    106106            return False 
    107107 
    108  
    109108class QuestEngine(dict): 
    110109    def __init__(self): 
    111110        """Create a quest engine object""" 
    112111        dict.__init__(self) 
    113  
    114112        self.empty_quest = Quest(None,None,None,None,{}) 
    115113        self.active_quests = {} 
     
    141139 
    142140        if isinstance(quest, str): 
    143             #Convert YAML to Quest 
     141            # Convert YAML to Quest 
    144142            tree = yaml.load(file(quest)) 
    145143 
     
    162160           @param quest_id: The id of the quest you want to move 
    163161           @return: True on success 
    164            @return: False when it failes 
    165         """ 
     162           @return: False when it failes""" 
    166163        if self.active_quests.has_key(quest_id): 
    167164            #Transfer to finished list 
     
    172169            #Temporary fix 
    173170            return True 
    174  
    175171        else: 
    176172            return False 
  • trunk/game/scripts/world.py

    r473 r476  
    8484        """Initialize the hud member 
    8585        @return: None""" 
    86  
    8786        hud_callbacks = { 
    8887            'saveGame': self.saveGame, 
     
    228227    def refreshTopLayerInstanceTransparencies(self): 
    229228        """Fade or unfade TopLayer instances if the PC is under them.""" 
    230  
    231229        # get the PC's screen coordinates 
    232230        camera = self.active_map.cameras[self.active_map.my_cam_id] 
     
    259257           @type position: String Tuple 
    260258           @param position: X,Y coordinates passed from engine.changeMap 
    261            @return: fife.Location 
    262         """ 
     259           @return: fife.Location""" 
    263260        print position 
    264261        coord = fife.DoublePoint3D(float(position[0]), float(position[1]), 0) 
     
    287284                    self.active_map.outline_render.addOutlined(self.highlight_obj, 0, \ 
    288285                                                               137, 255, 2) 
    289                         # get the text 
     286                    # get the text 
    290287                    item = self.data.objectActive(self.highlight_obj.getId()) 
    291288                    if item is not None: 
     
    345342        """ Pause/Unpause the game. 
    346343            @return: nothing""" 
    347          
    348344        self.active_map.togglePause() 
    349345     
     
    355351        self.engine.getModel().deleteMaps() 
    356352        self.engine.getModel().deleteObjects() 
    357  
    358353        self.maps = {} 
    359354 
Note: See TracChangeset for help on using the changeset viewer.