]> git.armaanb.net Git - lightcards.git/blob - lightcards/deck.py
Add comments to code
[lightcards.git] / lightcards / deck.py
1 # Classes pertaining to the card deck
2 # Armaan Bhojwani 2021
3
4 class Card(list):
5     """Card extends the list class, and adds ability to star them."""
6     starred = False
7
8     def unStar(self):
9         self.starred = False
10
11     def star(self):
12         self.starred = True
13
14     def toggleStar(self):
15         if self.starred:
16             self.starred = False
17         else:
18             self.starred = True
19
20     def getStar(self):
21         return self.starred
22
23     def printStar(self):
24         if self.starred:
25             return "★ Starred ★"
26         else:
27             return "Not starred"
28
29
30 class Status():
31     """The status class keeps track of where in the deck the user is"""
32     index = 0
33     side = 0
34
35     def forward(self, stack):
36         if not self.index == len(stack):
37             self.index += 1
38
39     def back(self):
40         if not self.index < 1:
41             self.index -= 1
42
43     def flip(self):
44         if self.side == 0:
45             self.side = 1
46         else:
47             self.side = 0
48
49     def setSide(self, inp):
50         self.side = inp
51
52     def setIdx(self, inp):
53         self.index = inp
54
55     def getSide(self):
56         return self.side
57
58     def getIdx(self):
59         return self.index