Ver Fonte

Completed documentation in group module

Zero! Studio há 1 ano atrás
pai
commit
d84144bcf6
1 ficheiros alterados com 21 adições e 0 exclusões
  1. 21 0
      jogai/group.py

+ 21 - 0
jogai/group.py

@@ -23,6 +23,12 @@ class RandomGroup(Group):
     """
     Group of randomly distributed characters.
 
+    Parameters:
+        model: character model to repeat
+        amount: amount of characters to spread
+        xrange: tuple with the minimum and maximum on x axis
+        yrange: tuple with the minimum and maximum on y axis
+
     Examples:
         >>> protagonist = Character('protagonist.png')
         >>> rg = RandomGroup(protagonist, 5, (100, 500), (0, 300))
@@ -82,6 +88,11 @@ class RectangleGroup(Group):
     """
     Group of characters forming a rectangle.
 
+    Parameters:
+        model: character model to repeat
+        base: number of characters in the base
+        height: number of characters in the height
+
     Examples:
         >>> protagonist = Character('protagonist.png')
         >>> rg = RectangleGroup(protagonist, 5, 3)
@@ -126,6 +137,10 @@ class SquareGroup(RectangleGroup):
     """
     Group of characters forming a square.
 
+    Parameters:
+        model: character model to repeat
+        side: number of characters by side
+
     Examples:
         >>> protagonist = Character('protagonist.png')
         >>> sg = SquareGroup(protagonist, 3)
@@ -147,6 +162,12 @@ class StairsGroup(Group):
     """
     Group of characters forming stairs.
 
+    Parameters:
+        model: character model to repeat
+        steps: number of steps in the stairs
+        horizontal_flip: True if flipped stairs in horizontal. False, otherwise
+        vertical_flip: True if flipped stairs in vertical. False, otherwise
+
     Examples:
         >>> protagonist = Character('protagonist.png')
         >>> sg = StairsGroup(protagonist, 3)