Changeset 500


Ignore:
Timestamp:
04/15/12 22:49:22 (3 years ago)
Author:
ecoughlan
Message:

return type vs output type

Location:
src
Files:
8 edited

Legend:

Unmodified
Added
Removed
  • src/buildMenu.py

    r496 r500  
    1717    def __init__(self, pos, visible, category, buildResponse, closeResponse):
    1818        """
    19             initializes the components of the InGameMenu subclass
    20             title is the name of the menu (i.e. research or build)
     19            initializes the components of the BuildMenu subclass, which
     20            contains menu pages as subwindows
    2121           
    22             input type: int((x,y)), bool(visible), str(title), str(image)
    23             """
     22            input type: int((x,y)), bool(visible), int(category),
     23                        function pointer(buildResponse),
     24                        function pointer(closeResponse)
     25        """
    2426        InGameMenu.__init__(self, pos, visible, closeResponse)
    2527        self.category = category
     
    5961           
    6062            input type: function pointer
    61             """
     63            return type: none
     64        """
    6265        self.subwindows[1].addResponse(response)
    6366
     
    6568        """
    6669            Moves to the previous block
    67             """
     70           
     71            input type: none
     72            return type: none
     73        """
    6874        if self.currentPage > 0:
    6975            self.subwindows[self.currentPage + 2].closeWindow()
     
    7682        """
    7783            Moves to the next block
    78             """
     84           
     85            input type: none
     86            return type: none
     87        """
    7988        if self.currentPage < self.numPages:
    8089            self.subwindows[self.currentPage + 2].closeWindow()
     
    8594
    8695    def openWindow(self):
    87         print "open window"
    8896        self.visible = True
    8997        print self.subwindows[self.currentPage + 2]
  • src/stats.py

    r499 r500  
    4545           
    4646            input type: none
    47             output type: none
     47            return type: none
    4848        """
    4949        self.visible = True
     
    5757           
    5858            input type: State(state)
    59             output type: none
     59            return type: none
    6060        """
    6161        for window in self.subwindows:
     
    7070
    7171            input type: pygame.event(e)
    72             output type: boolean
     72            return type: boolean
    7373        """
    7474        for i, window in enumerate(self.subwindows):
  • src/statusBar.py

    r499 r500  
    5454
    5555            input type: int(value)
     56            return type: none
    5657        """
    5758        self.value = max(-600, min(value, 600))
     
    6869           
    6970            input type: none
    70             output type: none
     71            return type: none
    7172        """
    7273        if self.isBuilding:
     
    9798           
    9899            input type: State(state)
    99             output type: none
     100            return type: none
    100101        """
    101102        self.updateValue(state.specs.stringToValue(self.category))
  • src/text.py

    r499 r500  
    4848           
    4949            input type: (int(x), int(y))
    50             output type: none
     50            return type: none
    5151        """
    5252        self.pos = (self.left, self.top) = pos
  • src/toolbar.py

    r499 r500  
    2424    def openWindow(self):
    2525        """
    26             opens the toolbar and all its subclasses
     26            opens the toolbar and all its subwindows
    2727           
    2828            input type: none
    29             output type: none
     29            return type: none
    3030        """
    3131        self.visible = True
  • src/top.py

    r497 r500  
    5050
    5151            input type: pygame.event(e)
    52             output type: none
     52            return type: none
    5353        """
    5454        if e.type == MOUSEBUTTONDOWN or e.type == KEYDOWN \
     
    107107           
    108108            input type: none
    109             output type: none
     109            return type: none
    110110        """
    111111        confirm = Alert((0, 0), True, "Are you sure you want to quit?",
     
    118118           
    119119            input type: none
    120             output type: none
     120            return type: none
    121121        """
    122122        pygame.quit()
     
    301301
    302302    def resume(self):
     303        """
     304            resumes a current game by opening main screen windows
     305            without any changes
     306           
     307            input type: none
     308            return type: none
     309        """
    303310        self.mainScreen()
    304311
     
    314321
    315322    def handleScene(self):
     323        """
     324            loads a scene, sets responses, then opens the windows to "play" it
     325           
     326            input type: none
     327            return type: none
     328        """
    316329        (sceneName, auxText) = self.gameData.dequeueScene()
    317330        if sceneName is not None:
     
    324337
    325338    def parseResponse(self, response):
     339        """
     340            parses the responses for the scene
     341           
     342            input type: str(response)
     343            return type: function pointer
     344        """
    326345        if response == "main_menu":
    327346            return self.menu
     
    338357           
    339358            input type: none
    340             output type: none
     359            return type: none
    341360        """
    342361        self.currentScene = []
     
    347366           
    348367            input type: none
    349             output type: none
     368            return type: none
    350369        """
    351370        for i in reversed(range(len(self.windows))):
     
    358377           
    359378            input type: none
    360             output type: none
     379            return type: none
    361380        """
    362381        for window in self.windows:
     
    368387           
    369388            input type: none
    370             output type: none
     389            return type: none
    371390        """
    372391        for window in self.windows:
     
    381400           
    382401            input type: bool(isLaunch)
    383             output type: none
     402            return type: none
    384403        """
    385404        self.menuModifier(isLaunch)
     
    396415           
    397416            input type: none
    398             output type: none
     417            return type: none
    399418        """
    400419        self.windows = self.gameWindows
     
    411430           
    412431            input type: none
    413             output type: none
     432            return type: none
    414433        """
    415434        self.windows = self.tutorialWindows + self.gameWindows
  • src/tutorial.py

    r497 r500  
    99            Initalizes a tutorial
    1010
    11             input type: (int(x),int(y)), bol(visible)
    12 
     11            input type: int((x,y)), bool(visible)
    1312        """
    1413        Window.__init__(self, pos, visible)
     
    7170
    7271            input type: pygame.event(e)
    73             output type: bool
     72            return type: bool
    7473        """
    7574        for window in self.subwindows:
     
    8988
    9089        input type: str(filename)
     90        return type: [Blank(blanks)]
    9191    """
    9292
  • src/window.py

    r490 r500  
    1717        """
    1818            initializes a window
     19           
     20            input type: int((x, y)), bool(visible), bool(stayBack)
    1921        """
    2022        self.subwindows = []
     
    3941
    4042            input type: pygame.event
    41             output type: boolean
     43            return type: boolean
    4244        """
    4345        for window in self.subwindows:
     
    7274        """
    7375            call response functions that had been designated to window
     76           
     77            input type: none
     78            return type: none
    7479        """
    7580        for functionTuple in self.responseFunctions:
     
    8085            Checks if the given position collides with this window.
    8186
    82             input type: pos
    83 
    84             output type: boolean
     87            input type: int((x,y))
     88            return type: boolean
    8589        """
    8690        for rectangle in self.rectangles:
     
    230234
    231235            input type: none
    232             output type: none
     236            return type: none
    233237        """
    234238        if self.hidden == True:
     
    242246
    243247            input type: none
    244             output type: none
     248            return type: none
    245249        """
    246250        self.hidden = False
     
    262266
    263267            input type: (int, int)
    264             output type: none
     268            return type: none
    265269        """
    266270        self.pos = pos
Note: See TracChangeset for help on using the changeset viewer.