student.adventure

Class Room

java.lang.Object

student.adventure.Room

public class Room
extends Object

Represents one location in the scenery of an adventure game. It is connected to other rooms via exits. For each existing exit, the room stores a reference to the neighboring room. This class is part of the "World of Zuul" framework for writing very simple text-based adventure games.

Version:

1.0 (February 2002)

Author:

Michael Kolling and David J. Barnes

Constructor Summary

Constructors

Constructor and Description
Room(String description) Create a room described "description".

Method Summary

Modifier and Type	Method and Description
Room	getExit(String direction) Return the room that is reached if we go from this room in direction "direction".
Set<String>	getExitDirections() Return a set of all of the directions one can exit from this room.
String	getExitString() Return a string describing the room's exits, for example "Exits: north west".
String	getLongDescription() Return a long description of this room, including a list of available exits.
String	getShortDescription() Return the description of the room (the one that was defined in the constructor).
void	setExit(String direction, Room neighbor) Define an exit from this room.

Methods inherited from class java.lang.Object

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

Constructor Detail

Room

public Room(String description)

Create a room described "description". Initially, it has no exits. "description" is something like "in a kitchen" or "in an open court yard".

Parameters:

description - The room's description

Method Detail

setExit

public void setExit(String direction,
                    Room neighbor)

Define an exit from this room.

Parameters:

direction - The direction of the exit

neighbor - The room connected to this one in the given direction

getShortDescription

public String getShortDescription()

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

Returns:

The room's description

getLongDescription

public String getLongDescription()

Return a long description of this room, including a list of available exits. The description is phrased in this form:

     You are in the kitchen.
     Exits: north west
 

Returns:

The room's description (prefixed with "You are " and followed by a period), together with the room's getExitString().

getExitString

public String getExitString()

Return a string describing the room's exits, for example "Exits: north west".

Returns:

A textual listing of the possible exit directions from this room

getExit

public Room getExit(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 direction to travel

Returns:

the neighboring room in the given direction

getExitDirections

public Set<String> getExitDirections()

Return a set of all of the directions one can exit from this room.

Returns:

A Set of string exit directions of the possible exits from this room