Skip to content

Commit 4947278

Browse files
committed
Add autodoc for some missing Team and Player attributes.
1 parent 95563bd commit 4947278

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

sc2reader/objects.py

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,15 @@ class Team(object):
3535
#: One of "Win", "Loss", or "Unknown"
3636
result = str()
3737

38+
#: A string representation of the team play races like PP or TPZZ. Random
39+
#: pick races are not reflected in this string
40+
lineup = str()
41+
3842
def __init__(self,number):
3943
self.number = number
4044
self.players = list()
4145
self.result = "Unknown"
46+
self.lineup = ""
4247

4348
def __iter__(self):
4449
return self.players.__iter__()
@@ -150,6 +155,30 @@ class Player(Person):
150155
#: A reference to the player's :class:`Team` object
151156
team = None
152157

158+
#: A reference to a :class:`Color` object representing the player's color
159+
color = None
160+
161+
#: The race the player picked prior to the game starting.
162+
#: Protoss, Terran, Zerg, Random
163+
pick_race = str()
164+
165+
#: The race the player ultimately wound up playing.
166+
#: Protoss, Terran, Zerg
167+
play_race = str()
168+
169+
#: The difficulty setting for the player. Always Medium for human players.
170+
#: Very easy, East, Medium, Hard, Very hard, Insane
171+
difficulty = str()
172+
173+
#: The player's handicap as set prior to game start, ranges from 50-100
174+
handicap = int()
175+
176+
#: The player's region
177+
region = str()
178+
179+
#: The subregion with in the player's region
180+
subregion = int()
181+
153182
def __init__(self, pid, name):
154183
super(Player,self).__init__(pid, name)
155184
self.is_observer = False

0 commit comments

Comments
 (0)