From bb4a79827940bdc89ad71d7ae5d1abc8de389e6d Mon Sep 17 00:00:00 2001
From: rustushki <rustushki>
Date: Tue, 28 Nov 2006 03:16:32 +0000
Subject: [PATCH] Added Documentation and stubbing for Asgard, Screen and
 BattleScreen.

---
 asgard.py | 36 ++++++++++++++++++++++++++++++++++++
 screen.py | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 96 insertions(+)
 create mode 100644 asgard.py
 create mode 100644 screen.py

diff --git a/asgard.py b/asgard.py
new file mode 100644
index 0000000..2da4e6d
--- /dev/null
+++ b/asgard.py
@@ -0,0 +1,36 @@
+class Asgard:
+	""" This is the game controller.  Currently, it mostly controls
+	battles, but does a few other meta processes that will no doubt be
+	completely unnecessary in a few releases.  Additionally, it handles
+	saving, loading and game initialization using binary saves and XML
+	files. """
+	
+	""" Copy Intance Vars from ConsoleController """
+
+	def wait(self):
+		""" Handles Pygame Events.  Especially quit, minimize, maximize, window movement, up, down, left, right, and enter.  When enter is pressed, it processes the requested operation (through hardcoded procedures). """
+		pass
+
+	def game(self):
+		""" Copy from ConsoleController (gameloop)"""
+		pass
+
+	def save(self):
+		""" Copy from ConsoleController """
+		pass
+	
+	def load(self):
+		""" Copy from ConsoleController """
+		pass
+
+	def loadStaticGameData(self,newGame):
+		""" Copy from ConsoleController """
+		pass
+
+	def unloadStaticGameData(self):
+		""" Copy from ConsoleController """
+		pass
+
+	def createRandomBattle(self):
+		""" Copy from ConsoleController """
+		pass
diff --git a/screen.py b/screen.py
new file mode 100644
index 0000000..b04b500
--- /dev/null
+++ b/screen.py
@@ -0,0 +1,60 @@
+class Screen(Surface):
+
+	layer1 = []
+	""" Layer 1 Drawables - Menu; this may change in the future. """
+
+	focus = None
+	""" Which drawable currently has focus on this Screen object. """
+
+	def __init__(self):
+		""" Handle inheriting from Surface. """
+		pass
+
+	def draw(self, display):
+		""" Draw each layer of this Screen object onto a given Surface. """
+		pass
+
+class BattleScreen(Screen):
+
+	def __init__(self):
+		""" Handle inheritance from Screen """
+
+	def drawFighterStatus(self):
+		""" Draw the dialogue menu at the bottom left of the screen that is
+		used to describe that status of all in-game Fighter objects,
+		both playable and not.  These should be sorted, monsters first
+		then playable heros.  The columns are Name, HP, MP, Status.
+		Status contains a list of abbreviations for the current status
+		afflictions. """ 
+		
+		pass
+
+	def drawCommands(self):
+		""" Draw a dialogue menu at the bottom right of the screen that
+		the user uses to select commands for playable Fighter objects.
+		At the moment, this should be limited to Attack, Magic, and
+		Quit. """
+		
+		pass
+
+	def drawStartup(self):
+		""" Draw a the tentatitve startup/inbetween battle menu in the
+		center of the screen.  It's current options are New Game, Load,
+		Save, Random Battle, and Quit. """
+	
+		pass
+	
+	def drawTransaction(self, transaction):
+		""" Draw a temporary transaction dialogue to the right of the
+		Fighter object that the transaction is taking place on. """
+		
+		pass
+	
+	def drawMagic(self, eventtypes, type):
+		""" Draw a menu used to select magic.  "type" is a string that
+		denotes which EventTypes will be listed.  "eventtypes" is the
+		list of EventTypes loaded at start."""
+		
+		pass
+
+
-- 
2.11.4.GIT