Changeset 142 for trunk/PARPG/scripts/engine.py

Timestamp:

06/15/09 12:36:00 (10 years ago)

Author:

maximinus_parpg

Message:

Fully epydocc'd engine.py.

File:

• trunk/PARPG/scripts/engine.py (modified) (11 diffs)

trunk/PARPG/scripts/engine.py

@@ -36 +36 @@
     """A MapDoor is an item that when clicked transports the player to
        another map"""
-    def __init__(self, name, new_map, targ_tup):
+    def __init__(self, name, new_map, location):
+        """@type name: string
+           @param name: name of fife object
+           @type new_map: string
+           @param new_map: name of new map
+           @type location: tuple
+           @param location: where to put the PC when map is loaded
+           @return: None"""
         self.id = name
         self.map = "maps/"+new_map+".xml"
-        # self.targ_coord: a (int, int) which stores the intended location 
+        # location is an (int, int) which stores the intended location 
         # of the PC on the new map
-        self.targ_coords = targ_tup
+        self.targ_coords = location
 
 class Engine:
-    """Engine holds the logic for the game
+    """Engine holds the logic for the game.
        Since some data (object position and so forth) is held in the
        fife, and would be pointless to replicate, we hold a instance of
        the fife view here. This also prevents us from just having a
-       function heavy controller"""
+       function heavy controller."""
     def __init__(self, view):
+        """Initialise the instance.
+           @type engine: world
+           @param engine: A world instance
+           @return: None"""
         # a World object
         self.view = view
@@ -60 +71 @@
     def reset(self):
         """Clears the data on a map reload so we don't have objects/npcs from
-           other maps hanging around."""
+           other maps hanging around.
+           @return: None"""
         self.PC = None
         self.npcs = []
@@ -68 +80 @@
     def loadObjects(self, filename):
         """Load objects from the XML file
-           Returns True if it worked, False otherwise"""
+           Returns True if it worked, False otherwise.
+           @type filename: string
+           @param filename: The XML file to read.
+           @rtype: boolean
+           @return: Status of result (True/False)"""
         try:
             objects_file = open(filename, 'rt')
@@ -93 +109 @@
 
     def addPC(self,pc):
-        """Add the PC to the world"""
+        """Add the PC to the world
+           @type pc: list
+           @param pc: List of data for PC attributes
+           @return: None"""
         if self.PC_targLoc:
             self.view.addObject(float(self.PC_targLoc[0]), \
@@ -107 +126 @@
     def addObjects(self,objects):
         """Add all of the objects we found into the fife map
-           and into our class
-           An NPC is just an object to FIFE"""
+           and into our class. An NPC is just an object to FIFE
+           @type objects: list
+           @param objects: List of objects to add
+           @return: None"""
         for i in objects:
             # is it visible?
@@ -117 +138 @@
 
     def addNPCs(self,npcs):
-        """Add all of the NPCs we found into the fife map
-           and into this class"""
+        """Add all of the NPCs we found into the fife map to FIFE.
+           @type npcs: list
+           @param npcs: List of NPC's to add
+           @return: None"""
         for i in npcs:
             self.view.addObject(float(i[0]), float(i[1]), i[2], i[3])
@@ -126 +149 @@
 
     def addDoors(self, doors):
-        """Add all the doors to the map as well
-           As an object they have already been added"""
+        """Add all the doors to the map as well.
+           As an object they will have already been added.
+           @type engine: list
+           @param engine: List of doors
+           @return: None"""
         for i in doors:
             self.doors.append(MapDoor(i[0], i[1], i[2]))
@@ -133 +159 @@
     def objectActive(self, ident):
         """Given the objects ID, pass back the object if it is active,
-           False if it doesn't exist or not displayed"""
+           False if it doesn't exist or not displayed
+           @type ident: string
+           @param ident: ID of object
+           @rtype: boolean
+           @return: Status of result (True/False)"""
         for i in self.objects:
             if((i.display == True)and(i.id == ident)):
@@ -147 +177 @@
 
     def getItemActions(self, obj_id):
-        """Given the objects ID, return the text strings and callbacks"""
+        """Given the objects ID, return the text strings and callbacks.
+           @type obj_id: string
+           @param obj_id: ID of object
+           @rtype: list
+           @return: List of text and callbacks"""
         actions=[]
         # note: ALWAYS check NPC's first!
@@ -177 +211 @@
 
     def loadMap(self,map_file):
-        """Load a new map
-           TODO: needs some error checking"""
+        """Load a new map. TODO: needs some error checking
+           @type map_file: string
+           @param map_file: Name of map file to load
+           @return: None"""
         # first we let FIFE load the rest of the map
         self.view.load(map_file)
@@ -186 +222 @@
 
     def handleMouseClick(self,position):
+        """Code called when user left clicks the screen.
+           @type position: fife.ScreenPoint
+           @param position: Screen position of click
+           @return: None"""
         self.PC.run(position)