home *** CD-ROM | disk | FTP | other *** search
/ GameStar 2006 January / Gamestar_80_2006-01_dvd.iso / Dema / Civilization4 / data1.cab / Civ4DemoComponent / Assets / Python / pyHelper / Unit.py < prev    next >
Encoding:
Python Source  |  2005-11-09  |  1.3 KB  |  48 lines
  1. ## Sid Meier's Civilization 4
  2. ## Copyright Firaxis Games 2005
  3. from CvPythonExtensions import *
  4. import Player as PyPlayer
  5.  
  6. gc = CyGlobalContext()
  7.  
  8. """ PyUnit(UnitID) to create instance
  9.  
  10.     This is the Unit Helper function class. It was designed to handle common CyUnit()
  11.     tasks. Each function is documented using the following format:
  12.         
  13.         def <functionName>(arguments):
  14.             "<return ObjectType> - description"
  15.         
  16.     ObjectType Key:
  17.         none    =    doesn't return a value
  18.         int        =    integer
  19.         intlist =   integer list
  20.         str        =    string
  21.         float    =    float
  22.         list    =    list
  23.         tuple    =    tuple
  24.         obj        =    object aka instance
  25.         objlist =    list of objects/instances
  26.         bool    =    boolean (True (1) or False (0))
  27.         
  28.     GOAL: To create easy to use Unit access functions. 
  29.     
  30.     - bmuzzin (Please feel free to contact with any feedback .. or you could ask Jesse ;) !)
  31. """
  32.  
  33. class PyUnit:
  34.  
  35.     def __init__(self, iPlayerID, iUnitID):
  36.         self.player = gc.getPlayer(iPlayerID)
  37.         self.unit = self.player.getUnit(iUnitID)
  38.  
  39.     def isNone(self):
  40.         "bool - Is the unit instance valid?"
  41.         return self.unit.isNone()
  42.     
  43.     ############## G E N E R A L ##############
  44.  
  45.     def NotifyEntity( self, iEvent ):
  46.         "none - tells this unit's entity to perform the given action"
  47.         self.unit.NotifyEntity( iEvent )
  48.