me.lihq.game.models

Class Room

java.lang.Object

me.lihq.game.models.Room

public class Room
extends java.lang.Object

This class defines a room which is a game representation of a real world room in the Ron Cooke Hub.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Room.Transition This object stores data the links the rooms together

Field Summary

Fields

Modifier and Type	Field and Description
private float	animationStateTime
private java.util.List<Clue>	cluesInRoom This is a list of the clues in the room.
java.util.List<Vector2Int>	hidingSpots This list stores the coordinates of all hideable slots in this room
private int	ID The integer ID of the room
private boolean[][]	lockedTiles This stores the coordinates of the map in a 2x2 array.
private com.badlogic.gdx.maps.tiled.TiledMap	map This stores the TMX map loaded from the String mapFile mapFile
private java.lang.String	mapFile The string that points to the tmx map file for this room.
private boolean	murderRoom This stores whether or not the room is the room where the murder happened
private java.lang.String	name This stores the name of the room.
private java.util.List<Room.Transition>	roomTransitions Room transitions stored as custom Transition object.

Constructor Summary

Constructors

Constructor and Description
Room(int id, java.lang.String mapFile, java.lang.String name) Constructor that builds a Room object from the given parameters

Method Summary

Modifier and Type	Method and Description
void	addClue(Clue newClue) Adds a clue to the room.
Room	addTransition(Room.Transition t) This adds a transition to the map.
void	drawClues(float delta, com.badlogic.gdx.graphics.g2d.Batch batch) This method draws the clues that are in the clue with the asset CLUE_GLINT
boolean	equals(java.lang.Object obj) This method checks equality between the Room and another object
Clue	getClue(int x, int y) This method takes a location parameter and checks it for a clue, if a clue is found it is removed from the map and return
java.util.List<Vector2Int>	getHidingSpots() This will check the map for any potential hiding locations, and returns them as a list of coordinates.
int	getID() Returns the integer ID of the room
java.lang.String	getMatRotation(int x, int y) This method gets the rotation that the map is that they are standing on.
java.lang.String	getName() This returns the String name of the room
Vector2Int	getRandHidingSpot() This gets a random possible location to hide a clue in
Vector2Int	getRandomLocation() This method returns a random location in the room that is walkable
com.badlogic.gdx.maps.tiled.TiledMap	getTiledMap() This returns the tiledMap for this room
Room.Transition	getTransitionData(int x, int y) This method will get the transition data (if available) for the associated door mat in this room at the location x y.
private Room.Transition	hasTransition(Vector2Int v) This method checks through all the transitions of this room and if one exists where the FROM property is equal to the parameter 'v' then it returns that Transition, else, it returns null
boolean	isHidingPlace(int x, int y) This method checks whether the tile at x, y is a tile you can hide a clue in
boolean	isMurderRoom() Returns True if it's the room the murder took place in
boolean	isTriggerTile(int x, int y) This method checks ALL layers for the tile at x, y to see if it is a trigger tile.
boolean	isWalkableTile(int x, int y) This method takes a current X and Y coordinate and checks through all the layers on the map to see if any tile IS NOT movable.
void	lockCoordinate(int x, int y) This method locks the specified coordinates so no other people object can move to it
void	setMurderRoom() Sets the room to be the murder room
void	unlockCoordinate(int x, int y) This method unlocks the specified coordinates so other people object can move to it

Methods inherited from class java.lang.Object

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

Field Detail

hidingSpots

public java.util.List<Vector2Int> hidingSpots

This list stores the coordinates of all hideable slots in this room

Hideable slots are tiles that the clues can be hidden in

name

private java.lang.String name

This stores the name of the room. It is displayed on the tag when they enter the room

ID

private int ID

The integer ID of the room

mapFile

private java.lang.String mapFile

The string that points to the tmx map file for this room.

cluesInRoom

private java.util.List<Clue> cluesInRoom

This is a list of the clues in the room.

murderRoom

private boolean murderRoom

This stores whether or not the room is the room where the murder happened

map

private com.badlogic.gdx.maps.tiled.TiledMap map

This stores the TMX map loaded from the String mapFile mapFile

lockedTiles

private boolean[][] lockedTiles

This stores the coordinates of the map in a 2x2 array. If a player/NPC attempts to move to a location, it locks the location before it moves, to avoid anything else moving to it.

roomTransitions

private java.util.List<Room.Transition> roomTransitions

Room transitions stored as custom Transition object. Defines where the transition is from and where it goes to

animationStateTime

private float animationStateTime

Constructor Detail

Room

public Room(int id,
            java.lang.String mapFile,
            java.lang.String name)

Constructor that builds a Room object from the given parameters

Parameters:

id - - The integer ID of the room

mapFile - - The String that points to the tmx map file.

name - - The name of the room

Method Detail

equals

public boolean equals(java.lang.Object obj)

This method checks equality between the Room and another object

Overrides:

equals in class java.lang.Object

Parameters:

obj - - The object to be checked against

Returns:

(boolean) Returns true if the obj is of type Room and has the exact same ID. ID

isMurderRoom

public boolean isMurderRoom()

Returns True if it's the room the murder took place in

Returns:

(boolean) the value of murderRoom

setMurderRoom

public void setMurderRoom()

Sets the room to be the murder room

getID

public int getID()

Returns the integer ID of the room

Returns:

(int) the value of ID

getName

public java.lang.String getName()

This returns the String name of the room

Returns:

(String) the value of name

addClue

public void addClue(Clue newClue)

Adds a clue to the room.

Parameters:

newClue - - The clue to add to the room

getClue

public Clue getClue(int x,
                    int y)

This method takes a location parameter and checks it for a clue, if a clue is found it is removed from the map and return

Parameters:

x - - The x coordinate the player is at

y - - The y coordinate the player is at

Returns:

(Clue) returns null if there is no clue at coordinate x,y and returns the clue itself otherwise

drawClues

public void drawClues(float delta,
                      com.badlogic.gdx.graphics.g2d.Batch batch)

This method draws the clues that are in the clue with the asset CLUE_GLINT

Parameters:

delta - - The time passed since the last draw. Used for the animation

batch - - The batch to draw the sprites to

isHidingPlace

public boolean isHidingPlace(int x,
                             int y)

This method checks whether the tile at x, y is a tile you can hide a clue in

Parameters:

x - - The x coordinate to check

y - - The y coordinate to check

Returns:

(boolean) whether the tile is a hideable tile.

lockCoordinate

public void lockCoordinate(int x,
                           int y)

This method locks the specified coordinates so no other people object can move to it

Parameters:

x - - The x coordinate to lock

y - - The y coordinate to lock

unlockCoordinate

public void unlockCoordinate(int x,
                             int y)

This method unlocks the specified coordinates so other people object can move to it

Parameters:

x - - The x coordinate to unlock

y - - The y coordinate to unlock

isWalkableTile

public boolean isWalkableTile(int x,
                              int y)

This method takes a current X and Y coordinate and checks through all the layers on the map to see if any tile IS NOT movable. If any tile IS NOT movable, it returns false.

Parameters:

x - - The x coordinate to check

y - - The y coordinate to check

Returns:

- (boolean) whether or not that tile can be walked on.

isTriggerTile

public boolean isTriggerTile(int x,
                             int y)

This method checks ALL layers for the tile at x, y to see if it is a trigger tile. If any of them are true, it returns true

Parameters:

x - - The x coordinate to check

y - - The y coordinate to check

Returns:

- (boolean) whether or not the tile is a trigger tile.

getMatRotation

public java.lang.String getMatRotation(int x,
                                       int y)

This method gets the rotation that the map is that they are standing on. If they aren't on a mat, it returns null

Parameters:

x - - The x coordinate to check

y - = The y coordinate to check

Returns:

a String representing the direction they are facing

getTiledMap

public com.badlogic.gdx.maps.tiled.TiledMap getTiledMap()

This returns the tiledMap for this room

Returns:

- (TiledMap) the map relating to this room.

addTransition

public Room addTransition(Room.Transition t)

This adds a transition to the map.

Parameters:

t - - The transition to be added

Returns:

- (Room) itself

getHidingSpots

public java.util.List<Vector2Int> getHidingSpots()

This will check the map for any potential hiding locations, and returns them as a list of coordinates.

Returns:

List of coordinates of the possible tiles.

getRandHidingSpot

public Vector2Int getRandHidingSpot()

This gets a random possible location to hide a clue in

Returns:

(Vector2Int) Coordinates of the tile where the clue is to be hidden, null if there are none available

getTransitionData

public Room.Transition getTransitionData(int x,
                                         int y)

This method will get the transition data (if available) for the associated door mat in this room at the location x y.

Parameters:

x - - The current x coordinate in the room (in terms of tiles not pixels)

y - - The current y coordinate in the room (in terms of tiles not pixels)

Returns:

- (Transition) a Transition data type. Which stores the relevant information. null if there is no transition at x, y

hasTransition

private Room.Transition hasTransition(Vector2Int v)

This method checks through all the transitions of this room and if one exists where the FROM property is equal to the parameter 'v' then it returns that Transition, else, it returns null

Parameters:

v - - The vector containing the FROM coordinates

Returns:

- (Transition) nullable Transition - the transition if it exists, else, null

getRandomLocation

public Vector2Int getRandomLocation()

This method returns a random location in the room that is walkable

Returns:

(Vector2Int) the random walkable tile generated.