home *** CD-ROM | disk | FTP | other *** search
/ GameStar 2006 January / Gamestar_80_2006-01_dvd.iso / Dema / Civilization4 / data1.cab / Civ4DemoComponent / Assets / Python / CvScreenUtils.py < prev    next >
Encoding:
Text File  |  2005-11-09  |  2.7 KB  |  74 lines
  1. ## Sid Meier's Civilization 4
  2. ## Copyright Firaxis Games 2005
  3. ##
  4. ## CvScreenUtils.py
  5. ## Class specifically for modders to add to CvScreensInterface.py
  6. ## Associated Files: CvScreensInterface, CvScreenUtilsInterface
  7. ##
  8. ## Usage: 1) Create a file in the mods python folder called Cv<Mod>ScreenUtils
  9. ##        2) Create a class derived from CvScreenUtils in that file ' class <Mod>ScreenUtils(CvScreenUtils): '
  10. ##        3) Copy into Python\EntryPoints\ a copy of CvScreenUtilsInterface
  11. ##        4) Change normalScreenUtils to use your mod ScreenUtils ' normalScreenUtils = <Mod>ScreenUtils.<Mod>ScreenUtils '
  12.  
  13. import ScreenInput as PyScreenInput
  14.  
  15. class CvScreenUtils:
  16.     # Place any screens that you would like to handle input in HandleInputMap
  17.     # You can also overwrite control from the default interface by returning 1 from any function
  18.     HandleInputMap = {                  
  19.                     # add new screens here
  20.                     }
  21.     
  22.     def leftMouseDown (self, argsList):
  23.         # return 1 to consume the input
  24.         screenEnum = argsList[0]
  25.         return 0
  26.             
  27.     def rightMouseDown (self, argsList):
  28.         # return 1 to consume the input
  29.         screenEnum = argsList[0]
  30.         return 0
  31.  
  32.     def mouseOverPlot(self, argsList):
  33.         # return 1 to consume the input
  34.         screenEnum = argsList[0]
  35.         return 0
  36.  
  37.     def update(self, argsList):
  38.         screenEnum = argsList[0]
  39.         if (self.HandleInputMap and self.HandleInputMap.has_key(screenEnum)):
  40.             screen = self.HandleInputMap.get(screenEnum)
  41.             screen.update(argsList[1])
  42.         return 0
  43.  
  44.     def handleInput (self, argsList):
  45.         ' handle input is called when a screen is up '
  46.         screenEnum, inputClass = argsList 
  47.         if (self.HandleInputMap and inputClass and self.HandleInputMap.has_key(screenEnum)):
  48.             # get the screen that is active from the HandleInputMap Dictionary
  49.             screen = self.HandleInputMap.get( inputClass.getPythonFile() )
  50.         
  51.             # call handle input on that screen
  52.             if ( screen ):
  53.                 # return 1 to consume input
  54.                 return screen.handleInput(inputClass)
  55.         return 0
  56.  
  57.     # Forced screen update
  58.     def forceScreenUpdate (self, argsList):
  59.         screenEnum = argsList[0]
  60.         # place call to update function here
  61.         return 0
  62.  
  63.     # Forced redraw
  64.     def forceScreenRedraw (self, argsList):
  65.         screenEnum = argsList[0]
  66.         # place call to redraw function here
  67.         return 0
  68.  
  69.     # Minimap Clicked
  70.     def minimapClicked(self, argsList):
  71.         screenEnum = argsList[0]
  72.         # place call to mini map function here
  73.         return 0
  74.