Changeset 511

Show
Ignore:
Timestamp:
04/16/2012 05:44:44 PM (2 years ago)
Author:
mmorton
Message:
 
Location:
src
Files:
16 modified

Legend:

Unmodified
Added
Removed
  • src/alert.py

    r492 r511  
    1414 
    1515class Alert(Window): 
    16  
    17     # by convention, the first subwindow is the affirmative button, 
    18     # so set responses accordingly 
     16    """ 
     17        Defines the alert class, inherits from window. 
     18        by convention, the first subwindow is the affirmative button, 
     19        so set responses accordingly. 
     20    """ 
    1921 
    2022    def __init__(self, pos, visible, message, yesResponse=None, yesText="Ok"): 
     23        """ 
     24            Initializes object. 
     25             
     26            input type: (int int)(pos) bool(visible) str(message)  
     27                        function(yesResponse) str(yesText) 
     28            return type: none 
     29        """ 
    2130        self.updateFunc = None 
    2231 
     
    5059 
    5160    def addYesResponse(self, response): 
     61        """ 
     62            adds the function to call when the affirmative button is pressed. 
     63             
     64            input type: function(response) 
     65            return type: none 
     66        """ 
    5267        self.subwindows[0].addResponse(response) 
    5368 
    5469    def openWindow(self): 
     70        """ 
     71            opens the window and subwindows. 
     72             
     73            input type: none 
     74            return type: none 
     75        """ 
    5576        self.visible = True 
    5677        self.openSubwindow() 
    5778 
    5879    def response(self, e): 
     80        """ 
     81            runs default windows response and then returns true. 
     82            This ensures that no other windows will respond. 
     83             
     84            input type: pygame.event(e) 
     85            return type: bool 
     86        """ 
    5987        Window.response(self, e) 
    6088        return True 
    6189 
    6290    def defineUpdate(self, updateFunc): 
     91        """ 
     92            Allows the update function to be redefined. 
     93             
     94            input type: function(updateFunc) 
     95            return type: none 
     96        """ 
    6397        self.updateFunc = updateFunc 
    6498 
    6599    def update(self, state): 
     100        """ 
     101            updates the window and all subwindows. 
     102             
     103            input type: state(state) 
     104            return type: none 
     105        """ 
    66106        if self.updateFunc == None: 
    67107            Window.update(self, state) 
  • src/alien.py

    r478 r511  
    1414 
    1515class Alien(Window): 
     16    """ 
     17        The alien class creates random aliens on blocks. 
     18    """ 
     19     
    1620    def __init__(self, pos, visible, blockNum, alienArt, message=None): 
     21        """ 
     22            Initializes the alien. 
     23        """ 
    1724        Window.__init__(self, pos, visible) 
    1825        self.blockNum = blockNum 
  • src/backButton.py

    r415 r511  
    1212 
    1313class BackButton(Window): 
     14    """ 
     15        Backbutton for screen class. 
     16    """ 
     17     
    1418    def __init__(self, pos, visible, backResponse): 
     19        """ 
     20            Initializes the back button. 
     21        """ 
    1522        Window.__init__(self, pos, visible) 
    16  
    17         """ 
    18         self.rectangles.append(Rectangle(self.pos, 56, 25, GRAY)) 
    19         self.text.append(Text(self.pos, "BACK", XSM_TEXT, FAKEBLACK, 56, True)) 
    20         """ 
    2123 
    2224        self.images.append(Image(self.pos, DIM.W, DIM.H, buttonDir + "back_button")) 
  • src/background.py

    r358 r511  
    1313 
    1414class Background(Window): 
     15    """ 
     16        Background is an image that does not interact with the user. 
     17    """ 
     18     
    1519    def __init__(self, pos, visible, image, doRestore=False): 
    1620        """ 
  • src/blank.py

    r493 r511  
    1616 
    1717class Blank(Window): 
     18    """ 
     19        Creates an invisible object that does not interact, but does not allow 
     20        interactions to pass through. 
     21    """ 
     22     
    1823    def __init__(self, pos, visible, index, text, arrowLoc, arrowDirection): 
    1924        """ 
     
    5156 
    5257    def openWindow(self): 
     58        """ 
     59            opens the window and all its subwindows. 
     60             
     61            input type: none 
     62            return type: none 
     63        """ 
    5364        self.visible = True 
    5465        for window in self.subwindows: 
    5566            window.openWindow() 
    56  
    57  
    58  
  • src/block.py

    r493 r511  
    2929 
    3030            input type: int((x,y)), bool(visible), int(ID) 
     31            return type: none 
    3132        """ 
    3233        Window.__init__(self, pos, visible) 
     
    7172 
    7273    def closeWindow(self): 
     74        """ 
     75            Closes the window and all subwindows. 
     76             
     77            input type: none 
     78            return type: none 
     79        """ 
    7380        self.visible = False 
    7481        for window in self.subwindows: 
     
    115122    def addLifeForms(self, alienMsg, charMsg): 
    116123        """ 
    117             adds the aliens and character to the map 
     124            adds the aliens and character to the map. 
     125             
    118126            input type: str(alienMsg), str(charMsg) 
     127            return type: none 
    119128        """ 
    120129        alienPos = choice(self.alienLoc) 
     
    131140             
    132141            input type: int(blockNum) 
    133             """ 
     142            return type: none 
     143        """ 
    134144        try: 
    135145            landscapeData = open(mapDataDir + "landscape" + str(self.ID) + ".txt") 
  • src/buildDescription.py

    r490 r511  
    1919 
    2020            input type: Info 
     21            return type: none 
    2122        """ 
    2223        DetailedDescription.__init__(self, pos, visible, False, info) 
     
    2930    def toggle(self): 
    3031        """ 
    31             Toggles whether the window and subwindows are open/closed 
     32            Toggles whether the window and subwindows are open/closed. 
     33             
     34            input type: none 
     35            return type: none 
    3236        """ 
    3337        self.visible = not self.visible 
     
    3741    def openWindow(self): 
    3842        """ 
    39             Opens the window and all its subwindows 
     43            Opens the window and all its subwindows. 
     44             
     45            input type: none 
     46            return type: none 
    4047        """ 
    4148        self.visible = True 
  • src/buildMenu.py

    r500 r511  
    1515 
    1616class BuildMenu(InGameMenu): 
     17    """ 
     18        The build menu gives access to the different categories of buildings 
     19        that can be built. 
     20    """ 
     21     
    1722    def __init__(self, pos, visible, category, buildResponse, closeResponse): 
    1823        """ 
     
    9499 
    95100    def openWindow(self): 
     101        """ 
     102            opens the window 
     103             
     104            input type: none 
     105            return type: none 
     106        """ 
    96107        self.visible = True 
    97108        print self.subwindows[self.currentPage + 2] 
     
    100111 
    101112    def closeWindow(self): 
     113        """ 
     114            closes the window and subwindows 
     115             
     116            input type: none 
     117            return type: none 
     118        """ 
    102119        self.visible = False 
    103120        self.subwindows[self.currentPage + 2].closeWindow() 
     
    114131             
    115132            input type: pygame.event 
    116              
    117133            output type: boolean 
    118134            """ 
  • src/buildMenuEntry.py

    r490 r511  
    1616 
    1717class BuildMenuEntry(MenuEntry): 
     18    """ 
     19        the entries to the build menus. 
     20    """ 
     21     
    1822    def __init__(self, pos, visible, building): 
     23        """ 
     24            initializes the build menu entries. 
     25             
     26            input type: (int int)(pos) bool(visible) building(building) 
     27            return type: none 
     28        """ 
    1929        self.able = (CAN_BUILD, "") 
    2030        self.building = building 
     
    3949 
    4050            input type: function pointer 
     51            return type: none 
    4152        """ 
    4253        self.buildResponse = response 
     
    4455 
    4556    def doBuild(self): 
     57        """ 
     58            runs the build response 
     59             
     60            input type: none 
     61            return type: none 
     62        """ 
    4663        self.buildResponse(self.building) 
    4764 
    4865    def update(self, state): 
     66        """ 
     67            defines the update response of the object. 
     68             
     69            input type: state 
     70            return type: none 
     71        """ 
    4972        newAvailability = state.checkThresh(self.building.name) 
    5073        if not (self.able == newAvailability): 
  • src/buildables.py

    r435 r511  
    1212__all__ = ["buildingLUT"] 
    1313 
    14  
    1514buildingLUT = {} 
    1615 
    17  
    1816def loadAllBuildings(): 
     17    """ 
     18        Loads all the buildings into the building look up table. 
     19         
     20        input type: none 
     21        return type: none 
     22    """ 
    1923    buildingFiles = os.listdir(buildingDir) 
    2024    for f in buildingFiles: 
  • src/building.py

    r490 r511  
    1313 
    1414class Building: 
    15     """ Contains data and stats object for each building """ 
     15    """ 
     16        Contains data and stats object for each building. 
     17    """ 
    1618 
    1719    def __init__(self, name, buildingType, stats, threshold, buildings=[]): 
     
    3840 
    3941    def __eq__(self, other): 
     42        """ 
     43            overwrites the = sign to compare names of the objects. 
     44        """ 
    4045        return self.name == other.name 
    4146 
     
    8287            input type: None 
    8388            return type: str(alienOpinion) 
    84  
    8589        """ 
    8690        return self.alien 
  • src/buildingStats.py

    r490 r511  
    99 
    1010class BuildingStats(): 
    11     """ Stats for each building """ 
     11    """ 
     12        Stats for each building 
     13    """ 
    1214 
    1315    def __init__(self): 
     
    5860 
    5961    def getCostText(self): 
     62        """ 
     63            returns the cost text from the building stat. 
     64             
     65            input type: none 
     66            return type: str 
     67        """ 
    6068        return self.oneTimeSpecs.getCostText() 
  • src/closeButton.py

    r415 r511  
    1212 
    1313class CloseButton(Window): 
     14    """ 
     15        Close button for menus and other windows. 
     16    """ 
     17     
    1418    def __init__(self, pos, visible, windowResponse, isGlowy=False): 
     19        """ 
     20            initializes the closebutton. 
     21             
     22            input type: (int int)(pos) bool(visible) function(windowResponse) 
     23                        bool(isGlow) 
     24        """ 
    1525        Window.__init__(self, pos, visible) 
    1626        if not isGlowy: 
  • src/detailedDescription.py

    r490 r511  
    1515 
    1616class DetailedDescription(Window): 
     17    """ 
     18        The detailed description for build and research. 
     19    """ 
     20     
    1721    def __init__(self, pos, visible, isResearch, info): 
     22        """ 
     23            initializes the detailed description. 
     24             
     25            input type: (int int)(pos) bool(visible) bool(isResearch) 
     26                        Info(info) 
     27            return type: none 
     28        """ 
    1829        Window.__init__(self, DIM.POS, visible) 
    1930        self.info = info 
     
    4051 
    4152    def getSimpleButton(self, yes=True): 
     53        """ 
     54            returns the yes or no button for the description. 
     55             
     56            input type: bool(yes) 
     57            return type: simpleButton 
     58        """ 
    4259        indices = self.getAllElements(SimpleButton) 
    4360        for i in indices: 
     
    4865 
    4966    def setYesResponse(self, response): 
     67        """ 
     68            sets the yes response for the window. 
     69             
     70            input type: function(response) 
     71            return type: none 
     72        """ 
    5073        i = self.getSimpleButton() 
    5174        if i != len(self.subwindows): 
     
    5376 
    5477    def setNoResponse(self, response): 
     78        """ 
     79            sets the no response for the window. 
     80             
     81            input type: function(response) 
     82            return type: none 
     83        """ 
    5584        i = self.getSimpleutton(False) 
    5685        if i != len(self.subwindows): 
  • src/heuristic.py

    r490 r511  
    6666 
    6767def saveHeuristic(heuristic): 
     68    """ 
     69        Saves the heuristic to a .heur file. 
     70         
     71        input type: heuristic(heuristic) 
     72        output type: none 
     73    """ 
    6874    try: 
    6975        heurData = open(heurDir + heuristic.name + heurExt, "wb") 
     
    7985def loadHeuristic(heuristicName): 
    8086    """ 
    81         Loads the building from a .trek file 
     87        Loads the heuristic from a .heur file. 
    8288 
    83         input type: str(fullFileName) 
    84         return type: Building(building) 
     89        input type: str(heuristicName) 
     90        return type: Heuristic(heuristic) 
    8591    """ 
    8692    try: 
  • src/hoverDescription.py

    r478 r511  
    1717        Window.__init__(self, DIM.POS, True) 
    1818        """ 
    19         if isResearch: 
    20             backgroundColor = CYAN 
    21         else: 
    22             backgroundColor = MAUVE 
    23         self.rectangles.append(Rectangle(self.pos, 460, 250, backgroundColor)) 
     19            Creates the general hover description window for other classes. 
    2420        """ 
    2521        self.images.append(Image(DIM.POS, 400, 60, buttonDir + "info_background"))