MuhammadAkbar-A2/MuhammadAkbar-A2-Documentation.docx
Written Exercise 1
Describe your game including the back story and the setting.
My game is based in a school. There are some rooms in the school and there are some exits at every room. In my game there is a fire blew up in the school, in order to win the game player must get out of the school in certain number of moves. Each room is locked by default and have one item in each room, the player must find safety items and add them into his inventory and then go to the any exit in given moves, if the player is unable to do that then he will lose the game. The player can have any number of items in his inventory.
List the items in the game
1. Fire Blanket
2. Mask
3. Fire Extinguishe
4. Torch
5. Wate
6. Sand
Explain how the player wins
The player must collect all the items in the game, add them into his inventory and then reach to any exit in moves before the fire goes out of control to win or else, he will lose.
Written Exercise 2
Written Exercise 3
Class Room
Instance variables
· Add an instance variable of type Room for the up exit
· Add an instance variable of type Room for the down exit
setExits method
· Add a parameter of type Room to the setExits method for the up exit
· Add a parameter of type Room to the setExits method for the down exit
· Add an if statement to the setExits method to assign the up parameter to the up instance variable
· Add an if statement to the setExits method to assign the down parameter to the down instance variable
getDescription method
· no changes needed
Class Game
Instance variables
· no changes needed
createRooms method
· Add an upExit argument of type Room to all the rooms calling setExits.
· Add an downExit argument of type Room to all the rooms calling setExits method.
play method
· no changes needed
printWelcome method
· Add an if statement to the printWelcome method to print “up”, if the upExit of the cu
ent room is not null.
· Add an if statement to the printWelcome method to print “down”, if the downExit of the cu
ent room is not null.
processCommand method
· no changes needed
printHelp method
· no changes needed
goRoom method
· Add an if statement to set the nextRoom to up room if the direction is "up"
· Add an if statement to set the nextRoom to up room if the direction is "down"
· Add an if statement to the printWelcome method to print up if the upExit of the cu
ent room is not null.
· Add an if statement to the printWelcome method to print down if the downExit of the cu
ent room is not null.
quit method
· no changes needed
Written Exercise 4
The printWelcome method and the goRoom methods contain code duplication and both print a description of the cu
ent room and a list of the exits. This is not a good design. Explain why.
Ans.
We should avoid duplication and write the common code in a separate method. Because if we keep duplicating and realised later that we need to make a small change then we will have to go in all the places where we duplicate the code and do it one by one and there will higher chance of e
ors. That’s the reason its always a good idea to have a separate method.
Written Exercise 5
In the previous exercise, you created the getRoomExitsAndDescription method that prints a description of the cu
ent room and a list of the exits. This code is contained in the Game class. This is not a good design. Explain why.
Ans.
getRoomExitsAndDescription is an attributes of game class. As all the attributes and methods of an object must be binded together in a single entity, so getRoomExitsAndDescription should be a part of room method.
Written Exercise 6
Class Room
Instance variables
· Add an instance variable of type Room for the up exit
· Add an instance variable of type Room for the down exit
setExits method
· Add a parameter of type Room to the setExits method for the up exit
· Add a parameter of type Room to the setExits method for the down exit
· Add an if statement to the setExits method to assign the up parameter to the up instance variable
· Add an if statement to the setExits method to assign the down parameter to the down instance variable
getDescription method
· no changes needed
getExitString method
· Add an if statement to the printWelcome method to add up to exit String if the upExit of the cu
ent room is not null.
· Add an if statement to the printWelcome method to add down to exit String if the downExit of the cu
ent room is not null.
Class Game
Instance variables
· no changes needed
createRooms method
· Add an argument of type Room to all the rooms calling setExits method for the up exit.
· Add an argument of type Room to all the rooms calling setExits method for the down exit.
play method
· no changes needed
printWelcome method
· no changes needed
processCommand method
· no changes needed
printHelp method
· no changes needed
goRoom method
· Add an if statement to set the nextRoom to up room if the direction is "up"
· Add an if statement to set the nextRoom to up room if the direction is "down"
quit method
· no changes needed
Written Exercise 7
Answer the following question. Has the design improved? You must explain why or why not.
Ans.
Yes, because We took of the code duplications and now if we want to change anything, we will only have to do it once in our method. Design is really improved now. Its more readable.
Name – Muhammad Gulraiz Akba
Student id XXXXXXXXXX
MuhammadAkbar-A2/MuhammadAkbar-Final/Command.class
public synchronized class Command {
private String commandWord;
private String secondWord;
public void Command(String, String);
public String getCommandWord();
public String getSecondWord();
public boolean isUnknown();
public boolean hasSecondWord();
}
MuhammadAkbar-A2/MuhammadAkbar-Final/Command.ctxt
#BlueJ class context
comment0.target=Command
comment0.text=\r\n\ This\ class\ is\ part\ of\ the\ "World\ of\ Zuul"\ application.\ \r\n\ "World\ of\ Zuul"\ is\ a\ very\ simple,\ text\ based\ adventure\ game.\ \ \r\n\r\n\ This\ class\ holds\ information\ about\ a\ command\ that\ was\ issued\ by\ the\ user.\r\n\ A\ command\ cu
ently\ consists\ of\ two\ strings\:\ a\ command\ word\ and\ a\ second\r\n\ word\ (for\ example,\ if\ the\ command\ was\ "take\ map",\ then\ the\ two\ strings\r\n\ obviously\ are\ "take"\ and\ "map").\r\n\ \r\n\ The\ way\ this\ is\ used\ is\:\ Commands\ are\ already\ checked\ for\ being\ valid\r\n\ command\ words.\ If\ the\ user\ entered\ an\ invalid\ command\ (a\ word\ that\ is\ not\r\n\ known)\ then\ the\ command\ word\ is\
.\r\n\r\n\ If\ the\ command\ had\ only\ one\ word,\ then\ the\ second\ word\ is\ .\r\n\ \r\n\ @author\ \ Michael\ K\u00F6lling\ and\ David\ J.\ Barnes\r\n\ @version XXXXXXXXXXr\n
comment1.params=firstWord\ secondWord
comment1.target=Command(java.lang.String,\ java.lang.String)
comment1.text=\r\n\ Create\ a\ command\ object.\ First\ and\ second\ word\ must\ be\ supplied,\ but\r\n\ either\ one\ (or\ both)\ can\ be\ null.\r\n\ @param\ firstWord\ The\ first\ word\ of\ the\ command.\ Null\ if\ the\ command\r\n\ \ \ \ \ \ \ \ XXXXXXXXXXwas\ not\ recognised.\r\n\ @param\ secondWord\ The\ second\ word\ of\ the\ command.\r\n
comment2.params=
comment2.target=java.lang.String\ getCommandWord()
comment2.text=\r\n\ Return\ the\ command\ word\ (the\ first\ word)\ of\ this\ command.\ If\ the\r\n\ command\ was\ not\ understood,\ the\ result\ is\ null.\r\n\ @return\ The\ command\ word.\r\n
comment3.params=
comment3.target=java.lang.String\ getSecondWord()
comment3.text=\r\n\ @return\ The\ second\ word\ of\ this\ command.\ Returns\ null\ if\ there\ was\ no\r\n\ second\ word.\r\n
comment4.params=
comment4.target=boolean\ isUnknown()
comment4.text=\r\n\ @return\ true\ if\ this\ command\ was\ not\ understood.\r\n
comment5.params=
comment5.target=boolean\ hasSecondWord()
comment5.text=\r\n\ @return\ true\ if\ the\ command\ has\ a\ second\ word.\r\n
numComments=6
MuhammadAkbar-A2/MuhammadAkbar-Final/Command.java
MuhammadAkbar-A2/MuhammadAkbar-Final/Command.java
public class Command
{
private String commandWord;
private String secondWord;
/**
* Create a command object. First and second word must be supplied, but
* either one (or both) can be null.
* @param firstWord The first word of the command. Null if the command
* was not recognised.
* @param secondWord The second word of the command.
*
public Command(String firstWord, String secondWord)
{
commandWord = firstWord;
this.secondWord = secondWord;
}
/**
* Return the command word (the first word) of this command. If the
* command was not understood, the result is null.
* @return The command word.
*
public String getCommandWord()
{
return commandWord;
}
/**
* @return The second word of this command. Returns null if there was no
* second word.
*
public String getSecondWord()
{
return secondWord;
}
/**
* @return true if this command was not understood.
*
public boolean isUnknown()
{
return (commandWord == null);
}
/**
* @return true if the command has a second word.
*
public boolean hasSecondWord()
{
return (secondWord != null);
}
}
MuhammadAkbar-A2/MuhammadAkbar-Final/CommandWords.class
public synchronized class CommandWords {
private static final String[] validCommands;
public void CommandWords();
public boolean isCommand(String);
public void showAll();
static void ();
}
MuhammadAkbar-A2/MuhammadAkbar-Final/CommandWords.ctxt
#BlueJ class context
comment0.target=CommandWords
comment0.text=\r\n\ This\ class\ is\ part\ of\ the\ "World\ of\ Zuul"\ application.\ "World\ of\ Zuul"\ is\ a\r\n\ very\ simple,\ text\ based\ adventure\ game.\r\n\ \r\n\ This\ class\ holds\ an\ enumeration\ of\ all\ command\ words\ known\ to\ the\ game.\ It\ is\r\n\ used\ to\ recognise\ commands\ as\ they\ are\ typed\ in.\r\n\r\n\ @author\ Michael\ K\u00F6lling\ and\ David\ J.\ Barnes\r\n\ @version XXXXXXXXXXr\n
comment1.params=
comment1.target=CommandWords()
comment1.text=\r\n\ Constructor\ -\ initialise\ the\ command\ words.\r\n
comment2.params=aString
comment2.target=boolean\ isCommand(java.lang.String)
comment2.text=\r\n\ Check\ whether\ a\ given\ String\ is\ a\ valid\ command\ word.\r\n\ \r\n\ @return\ true\ if\ it\ is,\ false\ if\ it\ isn't.\r\n
comment3.params=
comment3.target=void\ showAll()
comment3.text=\r\n\ Print\ all\ valid\ commands\ to\ System.out.\r\n
numComments=4
MuhammadAkbar-A2/MuhammadAkbar-Final/CommandWords.java
MuhammadAkbar-A2/MuhammadAkbar-Final/CommandWords.java
public class CommandWords {
a constant a
ay that holds all valid command words
private static final String[] validCommands = { "go", "quit", "help", "take", "inventory", };
/**
* Constructor - initialise the command words.
*
public CommandWords() {
nothing to do at the moment...
}
/**
* Check whether a given String is a valid command word.
*
* @return true if it is, false if it isn't.
*
public boolean isCommand(String aString) {
for (int i = 0; i < validCommands.length; i++) {
if (validCommands[i].equals(aString))
return true;
}
if we get here, the string was not found in the commands
return false;
}
/**
* Print all valid commands to System.out.
*
public void showAll() {
for (String command : validCommands) {
System.out.print(command + " ");
}
System.out.println();
}
}
MuhammadAkbar-A2/MuhammadAkbar-Final/Game.class
public synchronized class Game {
private Parser parser;
private Room cu
entRoom;
java.util.A
ayList userItem;
public void Game();
private void createRooms();
public void play();
private void printWelcome();
private boolean processCommand(Command);
private void printHelp();
private void goRoom(Command);
private void takeItem(Command);
void displayInventory();
private boolean quit(Command);
}
MuhammadAkbar-A2/MuhammadAkbar-Final/Game.ctxt
#BlueJ class context
comment0.target=Game
comment0.text=\r\n\ Class\ Room\ -\ a\ room\ in\ an\ adventure\ survival\ game.\r\n\r\n\ This\ class\ is\ the\ main\ class\ of\ the\ "Anna's\ Survival"\ application.\ "Anna's\r\n\ Survial"\ is\ a\ very\ simple,\ text\ based\ adventure\ survival\ game.\ Users\ can\ walk\r\n\ Anna\ around\ the\ school\ premises\ and\ lead\ her\ out\ of\ the\ shcool\ safely\ without\r\n\ exposing\ her\ to\ the\ deadly\ radiation\ due\ to\ chernobyl\ disaster.\ That's\ all.\r\n\ It\ should\ really\ be\ extended\ to\ make\ it\ more\ interesting\!\r\n\r\n\ A\ "Room"\ represents\ one\ room\ inside\ the\ school\ premise\ of\ the\ game.\ It\ is\r\n\ connected\ to\ other\ rooms\ via\ exits.\ For\ each\ existing\ exit,\ the\ room\ stores\ a\r\n\ reference\ to\ the\ neighboring\ room.\r\n\ \r\n\ @author\ John\ dow\r\n\ @version XXXXXXXXXXr\n
comment1.params=
comment1.target=Game()
comment1.text=\r\n\ Create\ the\ game\ and\ initialise\ its\ internal\ map.\r\n
comment10.params=command
comment10