Changeset 677

Show
Ignore:
Timestamp:
04/24/2012 02:12:50 PM (2 years ago)
Author:
rthomas
Message:

all done

Location:
src
Files:
9 modified

Legend:

Unmodified
Added
Removed
  • src/statusBarBuilding.py

    r643 r677  
    2020            used for coloring the bar. 
    2121 
    22             input type: int((x,y)), bool(visible), int(category), int(value) 
    23                         bool(isBad), bool(isBuilding) 
     22            input type: (int int)(pos), bool(visible), int(category), int(value) 
     23                        bool(isBad) 
    2424        """ 
    2525        self.scale = .5 
  • src/statusBarSpec.py

    r643 r677  
    2323            used for coloring the bar. 
    2424 
    25             input type: int((x,y)), bool(visible), int(category), int(value) 
    26                         bool(isBad), bool(isBuilding) 
     25            input type: (int int)(pos), bool(visible), int(category), int(value) 
     26                        bool(isBad) 
    2727        """ 
    2828        self.scale = 1 
     
    6464            Define the hover window for the object, by default none. 
    6565 
    66             input type: None 
     66            input type: pygame.Surface(surface) 
    6767            return type: None 
    6868        """ 
  • src/still.py

    r636 r677  
    2020            initializes the components of the Still subclass 
    2121 
    22             input type: int((x,y)), bool(visible), str(text), str(image) 
     22            input type: str(text), str(image) 
    2323        """ 
    2424        Window.__init__(self) 
  • src/text.py

    r611 r677  
    2828                -center determines if the text should be centered 
    2929 
    30             input type: (int, int), str, int, (int,int,int), int, bool, int 
     30            input type: (int, int)(pos), str(text), int(size),  
     31                        (int,int,int)(color), int(width), bool(center) 
    3132        """ 
    3233        self.text = text 
     
    4950            sets the position of text 
    5051 
    51             input type: (int(x), int(y)) 
     52            input type: (int int)(pos) 
    5253            return type: none 
    5354        """ 
     
    5657 
    5758    def setText(self, text): 
     59        """ 
     60            sets the text 
     61 
     62            input type: str(text) 
     63        """ 
    5864        self.text = text 
    5965        self.wrapped = self.wrapMultiLine() 
     
    6369            draw text to surface 
    6470 
    65             input type: pygame.Surface 
     71            input type: pygame.Surface(surface) 
    6672            return type: None 
    6773        """ 
     
    8894            resize text based off of screen size 
    8995 
    90             input type: (int, int) 
     96            input type: int(xScale), int(yScale) 
    9197            return type: none 
    9298        """ 
     
    111117            correct location 
    112118 
    113             input type: string 
    114             return type: int, bool, str 
     119            input type: str(text) 
     120            return type: int(lineLength), bool(done), str(stext) 
    115121        """ 
    116122        lineLength = len(text) 
     
    139145            helper function for wrapping a single line 
    140146 
    141             input type: str 
     147            input type: str(line) 
    142148            return type: [str] 
    143149        """ 
  • src/toolbar.py

    r636 r677  
    1717            initializes the components of the Toolbar subclass 
    1818 
    19             input type: int((x,y)), bool(visible), str(image) 
     19            input type: bool(visible), str(image) 
    2020        """ 
    2121        Window.__init__(self, (0, 0), visible) 
  • src/top.py

    r667 r677  
    3636            Initializes Top. 
    3737 
    38             input type: pygame.surface(surface) 
     38            input type: pygame.Surface(surface) 
    3939            return type: none 
    4040        ''' 
     
    177177            takes in a state and updates window as neccesary. 
    178178 
    179             input type: State(state) 
    180             return type: none 
     179            input type: None 
     180            return type: None 
    181181        """ 
    182182        for window in self.windows: 
     
    246246            deletes the current building from the map. 
    247247 
    248             input type: blockNumber(int), indexNumber(int) 
     248            input type: int(blockNumber), int(indexNumber) 
    249249            return type: none 
    250250        """ 
     
    256256            designated block. 
    257257 
    258             input type: blockNumber(int) 
     258            input type: int(blockNumber) 
    259259            return type: none 
    260260        """ 
     
    266266            then builds the building. 
    267267 
    268             input type: building(str) 
     268            input type: str(building) 
    269269            return type: none 
    270270        """ 
     
    282282            adds research to a designated type. 
    283283 
    284             input type: type(int), valueGetter(function) 
     284            input type: int(researchCat), function(valueGetter) 
    285285            return type: none 
    286286        """ 
     
    292292            returns the spec containing values of current resources. 
    293293 
    294             input type: none 
     294            input type: bool(full) 
    295295            return type: Spec(spec) 
    296296        """ 
     
    409409    def closes(self): 
    410410        """ 
    411             closes all windows, including subwindows 
     411            closes all windows 
    412412 
    413413            input type: none 
     
    418418 
    419419    def setMenuModifier(self, menuMethod): 
     420        """ 
     421            sets menu modifier 
     422 
     423            input type: function(menuMethod) 
     424        """ 
    420425        self.menuModifier = menuMethod 
    421426 
  • src/tutorial.py

    r636 r677  
    1010            Initalizes a tutorial 
    1111 
    12             input type: int((x,y)), bool(visible) 
     12            input type: None 
    1313        """ 
    1414        Window.__init__(self, (0, 0), True) 
     
    5959 
    6060    def closeCurrentIndex(self): 
     61        """ 
     62            closes the current part of the tutorial 
     63 
     64            input type: None 
     65            return type: None 
     66        """ 
    6167        for i in range(self.step): 
    6268            self.subwindows[self.currentIndex * self.step + i].close() 
    6369 
    6470    def openCurrentIndex(self): 
     71        """ 
     72            opens the current part of the tutorial 
     73             
     74            input type: None 
     75            return type: None 
     76        """ 
    6577        for i in range(self.step): 
    6678            self.subwindows[self.currentIndex * self.step + i].open() 
  • src/upDown.py

    r598 r677  
    1616            initializes the components of the UpDown subclass 
    1717 
    18             input type: int((x,y)), bool(visible), bool(isUp) 
     18            input type: (int int)(pos), bool(visible), bool(isUp) 
    1919        """ 
    2020        Window.__init__(self, pos, visible) 
  • src/window.py

    r635 r677  
    1818            initializes a window 
    1919 
    20             input type: int((x, y)), bool(visible), bool(stayBack) 
     20            input type: (int int)(pos), bool(visible), bool(stayBack) 
    2121        """ 
    2222        self.pos = pos 
     
    4545 
    4646            input type: pygame.event 
    47             return type: boolean 
     47            return type: bool 
    4848        """ 
    4949        for window in self.subwindows: 
     
    6363 
    6464            input type: none 
    65             return type: boolean 
     65            return type: bool 
    6666        """ 
    6767        if e.type == MOUSEBUTTONDOWN and 'button' in e.dict: 
     
    7979            takes in a state and updates window as neccesary. 
    8080 
    81             input type: state 
     81            input type: State(state) 
    8282            return type: none 
    8383        """ 
     
    9191            and then text 
    9292 
    93             input type: pygame.Surface 
     93            input type: pygame.Surface(surface) 
    9494            return type: None 
    9595        """ 
     
    109109            returns the hover description to display, by default none. 
    110110 
    111             input type: None 
     111            input type: pygame.Surface(surface) 
    112112            return type: None 
    113113        """ 
     
    118118            resize the entry based on new dimension 
    119119 
    120             input type: (int, int) 
     120            input type: int(xScale), int(yScale) 
    121121            return type: None 
    122122        """ 
     
    222222            Note that it does not check for collision with text 
    223223 
    224             input type: int((x,y)) 
    225             return type: boolean 
     224            input type: (int int)(pos) 
     225            return type: bool 
    226226        """ 
    227227        for rectangle in self.rectangles: 
     
    240240 
    241241            input type: none 
    242             return type: boolean 
     242            return type: bool 
    243243        """ 
    244244        return self.visible 
     
    257257            adds text to be displayed in window 
    258258 
    259             input type: Text 
     259            input type: Text(text) 
    260260            return type: None 
    261261        """ 
     
    266266            adds image to be displayed in window 
    267267 
    268             input type: Image 
     268            input type: Image(image) 
    269269            return type: None 
    270270        """ 
     
    276276            used for resizing 
    277277 
    278             input type: Rectangle 
     278            input type: Rectangle(rectangle) 
    279279            return type: None 
    280280        """ 
     
    285285            adds a window to the list of subwindows. 
    286286 
    287             input type: Window 
     287            input type: Window(window) 
    288288            return type: none 
    289289        """ 
     
    313313            type and with the given boolean attribute 
    314314 
    315             input type: windowType(Window), boolAttribute(str) 
     315            input type: windowType(Window), boolAttribute(str), bool(comparison) 
    316316            return type: int 
    317317        """