me.lihq.game.models

Class Clue

java.lang.Object

com.badlogic.gdx.graphics.g2d.TextureRegion

com.badlogic.gdx.graphics.g2d.Sprite

me.lihq.game.models.Clue

public class Clue
extends com.badlogic.gdx.graphics.g2d.Sprite

This class defines the clues that the player needs to find in order to solve the murder.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	description The description of the clue, set when you initialise the clue and gettable using getDescription()
private java.lang.String	name The name of the clue, set when you initialise the clue and gettable using getName()
private Vector2Int	tileCoordinates This is the location on the map in terms of tiles can be set using setTileCoordinates(int, int) Note: this is different to com.badlogic.gdx.graphics.g2d.Sprite.position that is the position on the screen in terms of pixels, whereas this is in terms of map tiles relative to the bottom left of the map.

Constructor Summary

Constructors

Constructor and Description
Clue(java.lang.String name, java.lang.String description, com.badlogic.gdx.graphics.g2d.TextureRegion texture) Creates a clue

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) This method checks equality of this Clue object and another object.
java.lang.String	getDescription() Getter for clue description
java.lang.String	getName() Getter for Clue name.
Vector2Int	getPosition() This method gets the Clue's current tile location on the map as a Vector2Int
int	getTileX() This method returns the x component of the clues tile coordinates from getPosition()
int	getTileY() This method returns the y component of the clues tile coordinates from getPosition()
Clue	setTileCoordinates(int x, int y) Setter for clue tile coordinates.
Clue	setTileCoordinates(Vector2Int v) This method calls the method of the same name but allows a Vector2Int as a parameter rather than the specific coordinates.

Methods inherited from class com.badlogic.gdx.graphics.g2d.Sprite

draw, draw, flip, getBoundingRectangle, getColor, getHeight, getOriginX, getOriginY, getRotation, getScaleX, getScaleY, getVertices, getWidth, getX, getY, rotate, rotate90, scale, scroll, set, setAlpha, setBounds, setCenter, setCenterX, setCenterY, setColor, setColor, setColor, setFlip, setOrigin, setOriginCenter, setPosition, setRegion, setRotation, setScale, setScale, setSize, setU, setU2, setV, setV2, setX, setY, translate, translateX, translateY

Methods inherited from class com.badlogic.gdx.graphics.g2d.TextureRegion

getRegionHeight, getRegionWidth, getRegionX, getRegionY, getTexture, getU, getU2, getV, getV2, isFlipX, isFlipY, setRegion, setRegion, setRegion, setRegion, setRegionHeight, setRegionWidth, setRegionX, setRegionY, setTexture, split, split

Methods inherited from class java.lang.Object

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

Field Detail

name

private java.lang.String name

The name of the clue, set when you initialise the clue and gettable using getName()

description

private java.lang.String description

The description of the clue, set when you initialise the clue and gettable using getDescription()

tileCoordinates

private Vector2Int tileCoordinates

This is the location on the map in terms of tiles can be set using setTileCoordinates(int, int) Note: this is different to com.badlogic.gdx.graphics.g2d.Sprite.position that is the position on the screen in terms of pixels, whereas this is in terms of map tiles relative to the bottom left of the map.

Constructor Detail

Clue

public Clue(java.lang.String name,
            java.lang.String description,
            com.badlogic.gdx.graphics.g2d.TextureRegion texture)

Creates a clue

Parameters:

name - the name of the clue i.e. what it is

description - describes what the clue is

texture - the texture region of the clue

Method Detail

equals

public boolean equals(java.lang.Object obj)

This method checks equality of this Clue object and another object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - - The clue object.

Returns:

- Returns True if it is of the type Clue and the names are exactly the same

getName

public java.lang.String getName()

Getter for Clue name.

Returns:

- (String) Returns name of clue.

getDescription

public java.lang.String getDescription()

Getter for clue description

Returns:

- (String) Returns the description of the clue.

setTileCoordinates

public Clue setTileCoordinates(Vector2Int v)

This method calls the method of the same name but allows a Vector2Int as a parameter rather than the specific coordinates.

It sets the tile coordinates of the clue in the map.

Parameters:

v - - The Vector2Int that the clue's tile coordinates are to be set to

Returns:

(Clue) returns this object once the location has been updated

setTileCoordinates

public Clue setTileCoordinates(int x,
                               int y)

Setter for clue tile coordinates.

Parameters:

x - - The x coordinate for where the clue is, in terms of tiles.

y - - The y coordinate for where the clue is, in terms of tiles.

all coordinates relative to bottom left of the map

Returns:

(Clue) this object

getPosition

public Vector2Int getPosition()

This method gets the Clue's current tile location on the map as a Vector2Int

Returns:

(Vector2Int) The tile coordinates of the clue

getTileX

public int getTileX()

This method returns the x component of the clues tile coordinates from getPosition()

Returns:

(int) The x tile coordinate of the clue

getTileY

public int getTileY()

This method returns the y component of the clues tile coordinates from getPosition()

Returns:

(int) The y tile coordinate of the clue