Added Documentation and stubbing for Asgard, Screen and BattleScreen.
[asgard.git] / screen.py
blobb04b5005adbb19ef0c1d1010a97bfd4f27d2fceb
1 class Screen(Surface):
3 layer1 = []
4 """ Layer 1 Drawables - Menu; this may change in the future. """
6 focus = None
7 """ Which drawable currently has focus on this Screen object. """
9 def __init__(self):
10 """ Handle inheriting from Surface. """
11 pass
13 def draw(self, display):
14 """ Draw each layer of this Screen object onto a given Surface. """
15 pass
17 class BattleScreen(Screen):
19 def __init__(self):
20 """ Handle inheritance from Screen """
22 def drawFighterStatus(self):
23 """ Draw the dialogue menu at the bottom left of the screen that is
24 used to describe that status of all in-game Fighter objects,
25 both playable and not. These should be sorted, monsters first
26 then playable heros. The columns are Name, HP, MP, Status.
27 Status contains a list of abbreviations for the current status
28 afflictions. """
30 pass
32 def drawCommands(self):
33 """ Draw a dialogue menu at the bottom right of the screen that
34 the user uses to select commands for playable Fighter objects.
35 At the moment, this should be limited to Attack, Magic, and
36 Quit. """
38 pass
40 def drawStartup(self):
41 """ Draw a the tentatitve startup/inbetween battle menu in the
42 center of the screen. It's current options are New Game, Load,
43 Save, Random Battle, and Quit. """
45 pass
47 def drawTransaction(self, transaction):
48 """ Draw a temporary transaction dialogue to the right of the
49 Fighter object that the transaction is taking place on. """
51 pass
53 def drawMagic(self, eventtypes, type):
54 """ Draw a menu used to select magic. "type" is a string that
55 denotes which EventTypes will be listed. "eventtypes" is the
56 list of EventTypes loaded at start."""
58 pass