mazeGUI

Class Room

java.lang.Object

mazeGUI.Room

Direct Known Subclasses:

Exit

public class Room
extends java.lang.Object

A room is a square shaped space with possible exits along the four walls

Since:

2014-02-22

Version:

1.0

Author:

Jack Myers

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.ArrayList<World.Direction>	exits
protected double	reward
private int	x
private int	y

Constructor Summary

Constructors

Constructor and Description
Room(int x, int y, double reward) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addExit(World.Direction exit) addExit will add an exit to a room
java.util.ArrayList<World.Direction>	getExits() Standard accessor method
Room	getLeftRoom(World world, World.Direction direction) getLeftRoom will return the room to the left
Room	getNextRoom(World world, World.Direction direction) getNextRoom will return the room that lies in the specified Direction
double	getReward() Standard accessor method
Room	getRightRoom(World world, World.Direction direction) getRightRoom will return the room to the right of an intended direction.
int	getX() Standard accessor method
int	getY() Standard accessor method
private World.Direction	leftOf(World.Direction direction) Utility function which returns the direction 90 degrees to the left of any direction.
Room	move(World world, World.Direction direction) move will move a player to the room that lies in the direction specified.
private World.Direction	rightOf(World.Direction direction) Utility function which returns the direction 90 degrees to the right of any direction.
void	setReward(double reward) Standard mutator method
void	setX(int x) Standard mutator method
void	setY(int y) Standard mutator method
java.lang.String	toString() Provides customized way to display a room object.

Methods inherited from class java.lang.Object

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

Field Detail

x

private int x

y

private int y

reward

protected double reward

exits

private java.util.ArrayList<World.Direction> exits

Constructor Detail

Room

public Room(int x,
    int y,
    double reward)

Constructor

Parameters:

x -

y -

reward -

Method Detail

addExit

public void addExit(World.Direction exit)

addExit will add an exit to a room

Parameters:

exit - The exit to add

move

public Room move(World world,
        World.Direction direction)

move will move a player to the room that lies in the direction specified. If there is no room in the direction, the next room will remain the same.

Parameters:

world - The world in which the room is contained

direction - The intended Direction the player wishes to move in

Returns:

The next room the player winds up in.

getNextRoom

public Room getNextRoom(World world,
               World.Direction direction)

getNextRoom will return the room that lies in the specified Direction

Parameters:

world - The world in which the room is contained

direction - The direction that will be used to determine the adjacent room

Returns:

Returns the next room if it exists, or the current room if it does not (if the next room does not exist, there is a wall there instead)

getRightRoom

public Room getRightRoom(World world,
                World.Direction direction)

getRightRoom will return the room to the right of an intended direction.

Parameters:

world - The world in which the room is contained

direction - The direction that the player was traveling in when he arrived in this room

Returns:

Returns the right room if it exists, or the current room if it does not (if the room to the right does not exist, there is a wall there instead)

getLeftRoom

public Room getLeftRoom(World world,
               World.Direction direction)

getLeftRoom will return the room to the left

Parameters:

world - The world in which the room is contained

direction - The direction that the player was traveling in when he arrived in this room

Returns:

Returns the left room if it exists, or the current room if it does not (if the room to the left does not exist, there is a wall there instead)

rightOf

private World.Direction rightOf(World.Direction direction)

Utility function which returns the direction 90 degrees to the right of any direction.

Parameters:

direction - The direction to evaluate

Returns:

The direction to the right of the parameter.

leftOf

private World.Direction leftOf(World.Direction direction)

Utility function which returns the direction 90 degrees to the left of any direction.

Parameters:

direction - The direction to evaluate

Returns:

The direction to the left of the parameter.

toString

public java.lang.String toString()

Provides customized way to display a room object.

Overrides:

toString in class java.lang.Object

getX

public int getX()

Standard accessor method

Returns:

x

setX

public void setX(int x)

Standard mutator method

getY

public int getY()

Standard accessor method

Returns:

y

setY

public void setY(int y)

Standard mutator method

getReward

public double getReward()

Standard accessor method

Returns:

reward

setReward

public void setReward(double reward)

Standard mutator method

getExits

public java.util.ArrayList<World.Direction> getExits()

Standard accessor method

Returns:

exits