me.lihq.game.people

Class AbstractPerson

java.lang.Object

com.badlogic.gdx.graphics.g2d.TextureRegion

com.badlogic.gdx.graphics.g2d.Sprite

me.lihq.game.people.AbstractPerson

Direct Known Subclasses:

NPC, Player

public abstract class AbstractPerson
extends com.badlogic.gdx.graphics.g2d.Sprite

The abstract person is an abstract representation of a person. A person can be a non playable character or Player. It extends the sprite class which provides methods for the person to be rendered in the game.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractPerson.Direction This is used to describe the direction the person is currently facing or moving in.
static class	AbstractPerson.Personality These are the possible personalities of the person
static class	AbstractPerson.PersonPositionComparator This class is to sort a list of AbstractPerson in highest Y coordinate to lowest Y coordinate
static class	AbstractPerson.PersonState The state of the person explains what they are currently doing.

Field Summary

Fields

Modifier and Type	Field and Description
protected float	animTime
protected float	animTimer The following variables control the walking animation speed
boolean	canMove This is whether the NPC can move or not.
protected com.badlogic.gdx.math.Vector2	coordinates This is the players location in the current room.
protected com.badlogic.gdx.graphics.g2d.TextureRegion	currentRegion This stores the current region of the above texture that is to be drawn to the map
private Room	currentRoom The current room of the AbstractPerson.
protected Vector2Int	destinationTile A store of the destination for a movement.
protected AbstractPerson.Direction	direction The direction determines the way the character is facing.
protected com.badlogic.gdx.utils.JsonValue	jsonData This is the JSON data for the Player/NPC
private java.lang.String	name The Name of the Person
protected static int	SPRITE_HEIGHT The height of the texture region for each person
protected static int	SPRITE_WIDTH The width of the texture region for each person
protected com.badlogic.gdx.graphics.Texture	spriteSheet This stores the sprite sheet of the Player/NPC
protected Vector2Int	startTile A store of the starting point for a movement.
protected AbstractPerson.PersonState	state This is the current walking state of the Person.
protected Vector2Int	tileCoordinates This is the location of the person in the room in terms of tiles eg (0,0) would be the bottom left of the room Uses the Vector2Int as the tileCoordinates should never be floats as the person should only be between tiles during the move process.

Constructor Summary

Constructors

Constructor and Description
AbstractPerson(java.lang.String name, java.lang.String img, int tileX, int tileY) This constructs the player calling super on the sprite class

Method Summary

Modifier and Type	Method and Description
void	finishMove() Finalises the move by resetting the animation timer and setting the state back to standing.
AbstractPerson.Direction	getDirection() Getter for direction.
java.lang.String	getName() This method returns the Persons name as a String
abstract AbstractPerson.Personality	getPersonality() This returns the persons personality
Room	getRoom() This method returns the room that the Person is in
java.lang.String	getSpeech(Clue clue) This method returns the response based on the clue given
abstract java.lang.String	getSpeech(Clue clue, AbstractPerson.Personality style) This handles speech for a clue that has a question style
java.lang.String	getSpeech(java.lang.String key) Gets a random item from the correct dictionary key.
AbstractPerson.PersonState	getState() This method returns the Persons walking state.
Vector2Int	getTileCoordinates() This method gets the Persons tile coordinates
abstract void	importDialogue(java.lang.String fileName) Reads in the JSON file of tha character and stores dialogue in the dialogue HashMap
void	initialiseMove(AbstractPerson.Direction dir) Sets up the move, initialising the start position and destination as well as the state of the person.
void	pushCoordinatesToSprite() This method moves the coordinates in the AbstractPersons coordinates to the Sprites position so that it can then be rendered at the correct location.
void	setAnimTime(float animTime) Setter for the animation time.
private void	setCoords(float x, float y) Used internally to store the coordinates of the person.
void	setDirection(AbstractPerson.Direction dir) Setter for the direction the person is facing.
void	setRoom(Room room) This method sets the currentRoom to the room parameter
void	setTileCoordinates(int x, int y) This sets the tile coordinates of the person.
void	update() This is called to update the players position.
void	updateTextureRegion() Updates the texture region based upon how far though the animation time it is.

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SPRITE_HEIGHT

protected static int SPRITE_HEIGHT

The height of the texture region for each person

SPRITE_WIDTH

protected static int SPRITE_WIDTH

The width of the texture region for each person

canMove

public boolean canMove

This is whether the NPC can move or not. It is mainly used to not let them move during converstation

tileCoordinates

protected Vector2Int tileCoordinates

This is the location of the person in the room in terms of tiles eg (0,0) would be the bottom left of the room Uses the Vector2Int as the tileCoordinates should never be floats as the person should only be between tiles during the move process.

coordinates

protected com.badlogic.gdx.math.Vector2 coordinates

This is the players location in the current room. Note this is different to sprite position, the sprite position is the location that the person is currently drawn. Avoid using Sprites setPosition as if it is changed mid render it will cause jolting.

startTile

protected Vector2Int startTile

A store of the starting point for a movement.

destinationTile

protected Vector2Int destinationTile

A store of the destination for a movement.

animTimer

protected float animTimer

The following variables control the walking animation speed

animTime

protected float animTime

spriteSheet

protected com.badlogic.gdx.graphics.Texture spriteSheet

This stores the sprite sheet of the Player/NPC

currentRegion

protected com.badlogic.gdx.graphics.g2d.TextureRegion currentRegion

This stores the current region of the above texture that is to be drawn to the map

jsonData

protected com.badlogic.gdx.utils.JsonValue jsonData

This is the JSON data for the Player/NPC

direction

protected AbstractPerson.Direction direction

The direction determines the way the character is facing.

state

protected AbstractPerson.PersonState state

This is the current walking state of the Person. getState()

name

private java.lang.String name

The Name of the Person

currentRoom

private Room currentRoom

The current room of the AbstractPerson.

Constructor Detail

AbstractPerson

public AbstractPerson(java.lang.String name,
                      java.lang.String img,
                      int tileX,
                      int tileY)

This constructs the player calling super on the sprite class

Parameters:

name - - The name of the Person

img - - this a path to the sprite sheet image

tileX - - This is the start x coordinate for the Person

tileY - - This is the start y coordinate for the Person

Method Detail

pushCoordinatesToSprite

public void pushCoordinatesToSprite()

This method moves the coordinates in the AbstractPersons coordinates to the Sprites position so that it can then be rendered at the correct location.

getState

public AbstractPerson.PersonState getState()

This method returns the Persons walking state. Either WALKING or STANDING

Returns:

(PersonState) the current state of the Person

setTileCoordinates

public void setTileCoordinates(int x,
                               int y)

This sets the tile coordinates of the person.

Parameters:

x - The x coordinate of the tile grid.

y - The y coordinate of the tile grid.

update

public void update()

This is called to update the players position. Called from the game loop, it interpolates the movement so that the person moves smoothly from tile to tile.

initialiseMove

public void initialiseMove(AbstractPerson.Direction dir)

Sets up the move, initialising the start position and destination as well as the state of the person. This allows the movement to be smooth and fluid.

Parameters:

dir - the direction that the person is moving in.

finishMove

public void finishMove()

Finalises the move by resetting the animation timer and setting the state back to standing. Called when the player is no longer moving.

importDialogue

public abstract void importDialogue(java.lang.String fileName)

Reads in the JSON file of tha character and stores dialogue in the dialogue HashMap

Parameters:

fileName -

getSpeech

public java.lang.String getSpeech(java.lang.String key)

Gets a random item from the correct dictionary key.

Parameters:

key -

Returns:

getSpeech

public java.lang.String getSpeech(Clue clue)

This method returns the response based on the clue given

Parameters:

clue - - The clue to get the response for

Returns:

(String) the string response

getSpeech

public abstract java.lang.String getSpeech(Clue clue,
                                           AbstractPerson.Personality style)

This handles speech for a clue that has a question style

Parameters:

clue - the clue to be questioned about

style - the style of questioning

Returns:

the speech

updateTextureRegion

public void updateTextureRegion()

Updates the texture region based upon how far though the animation time it is.

setCoords

private void setCoords(float x,
                       float y)

Used internally to store the coordinates of the person.

Parameters:

x - the x coordinate you wish to store

y - the y coordinate you wish to store

getPersonality

public abstract AbstractPerson.Personality getPersonality()

This returns the persons personality

Returns:

(Personality) returns the Persons personality

getName

public java.lang.String getName()

This method returns the Persons name as a String

Returns:

(String) the persons name name

getDirection

public AbstractPerson.Direction getDirection()

Getter for direction.

Returns:

(Direction) Returns the direction the person is facing.

setDirection

public void setDirection(AbstractPerson.Direction dir)

Setter for the direction the person is facing.

Parameters:

dir - - Desired direction for the person to face.

setAnimTime

public void setAnimTime(float animTime)

Setter for the animation time.

Parameters:

animTime - - The animation time you want to set.

getRoom

public Room getRoom()

This method returns the room that the Person is in

Returns:

(Room) the room the Person is in currentRoom

setRoom

public void setRoom(Room room)

This method sets the currentRoom to the room parameter

Parameters:

room - - The room to change currentRoom to currentRoom

getTileCoordinates

public Vector2Int getTileCoordinates()

This method gets the Persons tile coordinates

Returns:

(Vector2Int) the value of tileCoordinates tileCoordinates