Class Room

java.lang.Object

Room

public class Room
extends java.lang.Object

Class Room - a room in an adventure game. This class is part of the "World of Zuul" application. "World of Zuul" is a very simple, text based adventure game. A "Room" represents one location in the scenery of the game. It is connected to other rooms via exits. For each existing exit, the room stores a reference to the neighboring room.

Constructor Summary

Constructors

Constructor	Description
Room(java.lang.String description)	Create a room, given its description.

Method Summary

Modifier and Type	Method	Description
static java.util.HashMap<java.lang.String,Room>	createRooms(java.util.Scanner in)	Create rooms and their interconnections by taking room names, exit data and descriptions from a file Scanner, and return a map of room names to rooms.
Room	getExit(java.lang.String direction)	Return the room that is reached if we go from this room in direction "direction".
java.lang.String	getLongDescription()	Return a description of the room in the form: You are in the kitchen.
java.lang.String	getShortDescription()
void	setExit(java.lang.String direction, Room neighbor)	Define an exit from this room.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Room

public Room(java.lang.String description)

Create a room, given its description. Initially, it has no exits. Description is something like "a kitchen" or "an open court yard\nwith flowers all around".

Parameters:

description - The room's description.

Method Detail

createRooms

public static java.util.HashMap<java.lang.String,Room> createRooms(java.util.Scanner in)

Create rooms and their interconnections by taking room names, exit data and descriptions from a file Scanner, and return a map of room names to rooms. File format for each room:
First line: room name (one word)
Second line: pairs of exit direction and neighbor room name
Remaining paragraph: room description, blank line terminated

Parameters:

in - is the Scanner delivering all the room data

Returns:

A map of room names to rooms

setExit

public void setExit(java.lang.String direction,
                    Room neighbor)

Define an exit from this room.

Parameters:

direction - The direction of the exit.

neighbor - The room to which the exit leads.

getShortDescription

public java.lang.String getShortDescription()

Returns:

The short description of the room (the one that was defined in the constructor).

getLongDescription

public java.lang.String getLongDescription()

Return a description of the room in the form: You are in the kitchen. Exits: north west

Returns:

A long description of this room

getExit

public Room getExit(java.lang.String direction)

Return the room that is reached if we go from this room in direction "direction". If there is no room in that direction, return null.

Parameters:

direction - The exit's direction.

Returns:

The room in the given direction.