Package org.progettoedids.labyrinth

Class Labyrinth

java.lang.Object

org.progettoedids.labyrinth.Labyrinth

public class Labyrinth
extends Object

The Labyrinth class holds the state of the game's environment and supplies handy methods to access and make changes to the various components that make up the state.

Due to the complexity of the construction of a Labyrinth object, a Builder class is supplied, an instance of such class can be retrieved with the method newBuilder()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Labyrinth.Builder	It's the class responsible for Building a fully configured Labyrinth in a valid state.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Labyrinth()

Method Summary

Modifier and Type	Method	Description
void	addEntity(Position position, Entity entity)	Adds an Entity to the Labyrinth at the specified Position
boolean	canMoveByOne(UUID entityUUID, Direction direction)	Checks whether a move by one of a specific Entity in a certain Direction is allowed.
boolean	canPlayerGoBack()	Checks whether the Player can go back to its previous Position.
Difficulty	getDifficulty()	Returns the Difficulty of the Labyrinth
<T> Entity[]	getEntitiesInRoomWithPlayer(Class<T> entityClass)	Returns certain subtypes of Entity(ies) in Room with the Player.
Entity	getEntity(UUID entityUUID)	Returns the Entity associated with the specified UUID
Position	getEntityPosition(UUID entityUUID)	Returns the Position of the Entity with the specified UUID
String	getMatrixString()	Returns a matrix representation of all the rooms and the current position of the Player.
String	getName()	Returns the name of the Labyrinth
Player	getPlayer()	Returns the Player instance held by the Labyrinth
Position	getPlayerPosition()	Returns the Position of the Player in the Labyrinth
Room	getPlayerRoom()	Returns the Room instance where the Player is located
Random	getRandomGenerator()	Returns the Random generator to use for random numbers.
long	getRandomGeneratorSeed()
Room	getRoom(Position position)	Returns the Room instance associated with the Position supplied
boolean	isValidPosition(Position position)	Checks whether a Position is within the dimensions of the Room matrix
void	moveEntityByOne(UUID entityUUID, Direction direction)	Moves the Entity by one Room in a certain Direction.
static Labyrinth.Builder	newBuilder()	Returns an instance of Builder which is needed to build a Labyrinth.
void	playerGoBack()	Moves the Player back to its previous Position.
void	setEntityPosition(UUID entityUUID, Position entityWantedPosition)	Sets the Position of an Entity.

Methods inherited from class java.lang.Object

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

Constructor Details

Labyrinth

protected Labyrinth()

Method Details

getPlayer

public Player getPlayer()

Returns the Player instance held by the Labyrinth

Returns:

Player instance

getPlayerPosition

public Position getPlayerPosition()

Returns the Position of the Player in the Labyrinth

Returns:

Position of the Player

getPlayerRoom

public Room getPlayerRoom()

Returns the Room instance where the Player is located

Returns:

Player's Room

getEntitiesInRoomWithPlayer

public <T> Entity[] getEntitiesInRoomWithPlayer(Class<T> entityClass)

Returns certain subtypes of Entity(ies) in Room with the Player.

Usage example: getEntitiesInRoomWithPlayer(Monster.class)

Returns:

an array of Entity

getEntity

public Entity getEntity(UUID entityUUID)

Returns the Entity associated with the specified UUID

Parameters:

entityUUID - the UUID of the Entity to return. Must not be null

Returns:

the Entity associated with the specified UUID or null if not found

getEntityPosition

public Position getEntityPosition(UUID entityUUID)

Returns the Position of the Entity with the specified UUID

Parameters:

entityUUID - the UUID of the Entity to find the Position. Must not be null

Returns:

the Position of the Entity or null if not found

getRoom

public Room getRoom(Position position)

Returns the Room instance associated with the Position supplied

Parameters:

position - a valid Position in the Labyrinth. Must not be null

Returns:

The Room found at the Position supplied as an argument

canPlayerGoBack

public boolean canPlayerGoBack()

Checks whether the Player can go back to its previous Position.

Returns:

true if the Player has previous Position(s), false otherwise

playerGoBack

public void playerGoBack()

Moves the Player back to its previous Position.

Throws:

UnsupportedOperationException - if the Player can't go back because canPlayerGoBack returned false

canMoveByOne

public boolean canMoveByOne(UUID entityUUID,
 Direction direction)

Checks whether a move by one of a specific Entity in a certain Direction is allowed. For example, an Entity may not move in a certain Direction if the next Room in that direction is locked or if the Entity was about to move outside the edge of the Labyrinth.

Parameters:

entityUUID - the UUID of the Entity to move

direction - the Direction in which to move the Entity

Returns:

true if the Entity can legally move in that Direction, false otherwise

moveEntityByOne

public void moveEntityByOne(UUID entityUUID,
 Direction direction)

Moves the Entity by one Room in a certain Direction.

Parameters:

entityUUID - the UUID of the Entity to move. Must not be null

direction - the Direction to move the Entity towards. Must not be null

setEntityPosition

public void setEntityPosition(UUID entityUUID,
 Position entityWantedPosition)

Sets the Position of an Entity.

Please note that it's always preferable to use the moveEntityByOne method instead, if possible. If a Player Entity is moved its old Position is added to the stack of previous positions.

Parameters:

entityUUID - the UUID of the entity to move. Must not be null

entityWantedPosition - the Position where to move the Entity. Must not be null

Throws:

IllegalArgumentException - if the Position supplied is invalid

addEntity

public void addEntity(Position position,
 Entity entity)

Adds an Entity to the Labyrinth at the specified Position

Parameters:

position - the Position at which to place the Entity

entity - the Entity to insert in the Labyrinth

Throws:

IllegalArgumentException - if the Position supplied is invalid

isValidPosition

public boolean isValidPosition(Position position)

Checks whether a Position is within the dimensions of the Room matrix

Parameters:

position - a position. Must not be null

Returns:

true if the position is valid, false otherwise

getName

public String getName()

Returns the name of the Labyrinth

Returns:

String containing the name

getDifficulty

public Difficulty getDifficulty()

Returns the Difficulty of the Labyrinth

Returns:

the Difficulty enumerator of the Labyrinth

getRandomGenerator

public Random getRandomGenerator()

Returns the Random generator to use for random numbers.

Returns:

a Random generator

getRandomGeneratorSeed

public long getRandomGeneratorSeed()

getMatrixString

public String getMatrixString()

Returns a matrix representation of all the rooms and the current position of the Player.

Each room is labeled with its characterizing character and the Player is represented with a 'P'.

Returns:

a String with the representation

newBuilder

public static Labyrinth.Builder newBuilder()

Returns an instance of Builder which is needed to build a Labyrinth.

Returns:

a non-configured Builder