Merge branch 'zuul-with-images' into 'master'

Zuul With Images

7 files changed, 492 insertions, 275 deletions

diff --git a/report/progression.tex b/report/progression.tex
index da5e34e..f015634 100644
--- a/report/progression.tex
+++ b/report/progression.tex
@@ -114,11 +114,46 @@ passed to any method in any class.
 
 \subsection{Game, GameEngine, UserInterface}
 
+The following methods was implemented as part of commit 54e102463.
+
+\subsubsection{Game}
+
+The constructor of this class instantiates the GameEngine and the UserInterface,
+and set the output of the first to the second.
+
+\subsubsection{GameEngine}
+
+This class contains the attributes and methods previously contained in the Game
+class.
+
+Instead of printing to the standard console output, it prints to the GUI.
+
+\subsubsection{UserInterface}
+
+This class implements the graphical user interface of the game. It basically
+creates the different window components and provides methods to
+interact with them.
+
 \subsection{Parser/Scanner}
 
-\subsection{UserInterface.addActionListener()}
+Since commands are entered through a text field instead of the console, the
+use of Scanner that read from the standard system input is not required anymore.
+
+\subsection{addActionListener() and actionPerformed()}
+
+The addActionListener() of an object x takes as parameter an object y that have
+a actionPerformed() method. When an action event occurs on x, this method on y
+is called and an ActionEvent is passed as parameter.
+
+The actionPerformed() method then does the appropriate action according to the
+event that happened.
+
+\subsection{Add a button}
 
-\subsection{UserInterface.actionPerformed()}
+A help button was added with commit 7f153a4c1. The processCommand() method was
+modified to take the command String as parameter instead of reading it only from
+the text field, and the actionPerformed() method was modified accordingly to
+forward the command.
 
 
 \section{Zuul MVC}
diff --git a/src/esieequest/Command.java b/src/esieequest/Command.java
index fd05930..14c3d32 100644
--- a/src/esieequest/Command.java
+++ b/src/esieequest/Command.java
@@ -1,8 +1,6 @@
 package esieequest;
 
 /**
- * A text command that triggers an action in the game.
- * 
  * This class holds information about a command that was issued by the user. A
  * command currently consists of two strings: a command word and a second word
  * (for example, if the command was "take map", then the two strings obviously
@@ -33,8 +31,8 @@ public class Command {
          * @param secondWord
          *            The second word of the command.
          */
-        public Command(final String pCommandWord, final String pSecondWord) {
-                this.aCommandWord = pCommandWord;
+        public Command(final String pFirstWord, final String pSecondWord) {
+                this.aCommandWord = pFirstWord;
                 this.aSecondWord = pSecondWord;
         }
 
diff --git a/src/esieequest/Game.java b/src/esieequest/Game.java
index 43db8f7..a35cfb4 100644
--- a/src/esieequest/Game.java
+++ b/src/esieequest/Game.java
@@ -1,6 +1,6 @@
 package esieequest;
 
-import java.util.HashMap;
+import javax.swing.JApplet;
 
 /**
  * The game engine.
@@ -14,263 +14,16 @@ import java.util.HashMap;
  * 
  * @version February 2014
  */
-public class Game {
-        private HashMap<String, Room> aRooms;
-        private Room aCurrentRoom;
-        private Parser aParser;
+public class Game extends JApplet {
+        private UserInterface aGui;
+        private GameEngine aEngine;
 
         /**
-         * Create the game and initialize its internal map.
+         * Create the game and initialise its internal map.
          */
         public Game() {
-                this.aRooms = new HashMap<String, Room>();
-                this.createRooms();
-                this.aParser = new Parser();
-                this.play();
-        }
-
-        /**
-         * Main play routine. Loops until end of play.
-         */
-        private void play() {
-                this.printWelcome();
-                boolean vFinished = false;
-                while (!vFinished) {
-                        Command vCommand = this.aParser.getCommand();
-                        vFinished = this.processCommand(vCommand);
-                }
-
-                System.out.println("Thank you for playing. Good bye.");
-        }
-
-        /**
-         * Create all the rooms and link their exits together.
-         */
-        private void createRooms() {
-                // create rooms
-                this.aRooms.put("AmphitheaterSeat", new Room("in the amphitheater"));
-                this.aRooms.put("AmphitheaterStage", new Room("on the amphitheater stage"));
-
-                this.aRooms.put("CafeteriaStreet", new Room("in the main corridor, in front of the cafeteria"));
-                this.aRooms.put("Cafeteria", new Room("at the cafeteria"));
-
-                this.aRooms.put("EsieespaceStreet", new Room("in the main corridor, in front of the ESIEEspace HQ"));
-                this.aRooms.put("EsieespaceFront", new Room("in front of the ESIEEspace HQ"));
-                this.aRooms.put("EsieespaceEntrance", new Room("at the ESIEEspace HQ entrance"));
-                this.aRooms.put("Esieespace", new Room("in the ESIEEspace HQ"));
-
-                this.aRooms.put("ClubnixStreet", new Room("in the main corridor, in front of the Club*Nix"));
-                this.aRooms.put("ClubnixFront", new Room("in front of the Club*Nix"));
-                this.aRooms.put("ClubnixEntrance", new Room("at the Club*Nix entrance"));
-                this.aRooms.put("Clubnix", new Room("in the Club*Nix"));
-
-                this.aRooms.put("EntranceStreet", new Room("in the main corridor, at the reception"));
-                this.aRooms.put("EntranceStairs", new Room("on the main entrance stairs"));
-                this.aRooms.put("EntranceRoundabout", new Room("on the roundabout"));
-
-                this.aRooms.put("WingStreet", new Room("in font of wing #3"));
-                this.aRooms.put("WingCorridorOne", new Room("in the corridor in wing #3, on the ground floor"));
-                this.aRooms.put("WingStairsOne", new Room("in the stairwell on the ground floor"));
-                this.aRooms.put("WingStairsTwo", new Room("in the stairwell on the first floor"));
-                this.aRooms.put("WingCorridorTwo", new Room("in the corridor in wind #3, on the first floor"));
-                this.aRooms.put("WingCorridorTwoOffice", new Room("in front of the office #3254"));
-                this.aRooms.put("WingOffice", new Room("in the office #3254"));
-
-                this.aRooms.put("OffscriptEat", new Room("somewhere implementing hunger"));
-                this.aRooms.put("OffscriptEatPantry", new Room("in the pantry"));
-                this.aRooms.put("OffscriptTake", new Room("somewhere implementing weight"));
-                this.aRooms.put("OffscriptTakeStorageroom", new Room("in a storage room"));
-                this.aRooms.put("OffscriptTimeout", new Room("somewhere implementing time"));
-                this.aRooms.put("OffscriptTimeoutCountdownroom", new Room("in a dangerous room"));
-                this.aRooms.put("OffscriptTrapdoor", new Room("somewhere implementing a trap"));
-                this.aRooms.put("OffscriptTrapdoorDeadend", new Room("trapped"));
-                this.aRooms.put("OffscriptBeamer", new Room("somewhere implementing teleportation"));
-                this.aRooms.put("OffscriptBeamerAnchor", new Room("on a checkpoint"));
-                this.aRooms.put("OffscriptLock", new Room("somewhere implementing a doorlock"));
-                this.aRooms.put("OffscriptLockLockedroom", new Room("in a locked room that is not anymore"));
-                this.aRooms.put("OffscriptAlea", new Room("somewhere implementing alea"));
-                this.aRooms.put("OffscriptAleaRoomrandomizer", new Room("in a weird room that will transport you somewhere else"));
-                this.aRooms.put("OffscriptMovingcharacter", new Room("somewhere implementing a moving character"));
-                this.aRooms.put("OffscriptMovingcharacterMo", new Room("in M-O's room"));
-
-                // connect rooms
-                this.aRooms.get("AmphitheaterSeat").setExit("north", this.aRooms.get("AmphitheaterStage"));
-                this.aRooms.get("AmphitheaterStage").setExit("west", this.aRooms.get("Cafeteria"));
-
-                this.aRooms.get("CafeteriaStreet").setExit("south", this.aRooms.get("Cafeteria"));
-                this.aRooms.get("CafeteriaStreet").setExit("east", this.aRooms.get("EsieespaceStreet"));
-                this.aRooms.get("Cafeteria").setExit("north", this.aRooms.get("CafeteriaStreet"));
-                this.aRooms.get("Cafeteria").setExit("east", this.aRooms.get("AmphitheaterStage"));
-
-                this.aRooms.get("EsieespaceStreet").setExit("west", this.aRooms.get("Cafeteria"));
-                this.aRooms.get("EsieespaceStreet").setExit("south", this.aRooms.get("EsieespaceFront"));
-                this.aRooms.get("EsieespaceStreet").setExit("east", this.aRooms.get("EntranceStreet"));
-                this.aRooms.get("EsieespaceFront").setExit("north", this.aRooms.get("EsieespaceStreet"));
-                this.aRooms.get("EsieespaceFront").setExit("east", this.aRooms.get("EsieespaceEntrance"));
-                this.aRooms.get("EsieespaceEntrance").setExit("north", this.aRooms.get("Esieespace"));
-                this.aRooms.get("EsieespaceEntrance").setExit("west", this.aRooms.get("EsieespaceFront"));
-                this.aRooms.get("Esieespace").setExit("south", this.aRooms.get("EsieespaceEntrance"));
-
-                this.aRooms.get("ClubnixStreet").setExit("west", this.aRooms.get("WingStreet"));
-                this.aRooms.get("ClubnixStreet").setExit("south", this.aRooms.get("ClubnixFront"));
-                this.aRooms.get("ClubnixFront").setExit("north", this.aRooms.get("ClubnixStreet"));
-                this.aRooms.get("ClubnixFront").setExit("east", this.aRooms.get("ClubnixEntrance"));
-                this.aRooms.get("ClubnixEntrance").setExit("north", this.aRooms.get("Clubnix"));
-                this.aRooms.get("ClubnixEntrance").setExit("west", this.aRooms.get("ClubnixFront"));
-                this.aRooms.get("Clubnix").setExit("south", this.aRooms.get("ClubnixEntrance"));
-
-                this.aRooms.get("EntranceStreet").setExit("west", this.aRooms.get("EsieespaceStreet"));
-                this.aRooms.get("EntranceStreet").setExit("south", this.aRooms.get("EntranceStairs"));
-                this.aRooms.get("EntranceStreet").setExit("east", this.aRooms.get("WingStreet"));
-                this.aRooms.get("EntranceStairs").setExit("north", this.aRooms.get("EntranceStreet"));
-                this.aRooms.get("EntranceStairs").setExit("south", this.aRooms.get("EntranceRoundabout"));
+                this.aEngine = new GameEngine();
+                this.aGui = new UserInterface(this.aEngine);
+                this.aEngine.setGUI(this.aGui);