Package org.progettoedids.entities.players

Class Player

java.lang.Object

org.progettoedids.entities.Entity

org.progettoedids.entities.players.Player

Direct Known Subclasses:

Armin, Lisa

public class Player
extends Entity

A Player is an Entity which is characterized by a certain health and an Inventory.

The Player starts with a certain health and can lose and gain it, if the Player's health reaches or goes below zero then the Player is considered dead, no limits are set on the amount of health it can gain.

Field Summary

Fields

Modifier and Type	Field	Description
protected Inventory	inventory

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Player(String systemName, String name, int health, Inventory inventory)	Initializes Player.

Method Summary

Modifier and Type	Method	Description
void	decreaseHealth(int amount)	Decreases the health of the Player by a certain amount.
int	getHealth()	Returns the health of the Player.
Inventory	getInventory()	Returns the inventory of the Player.
void	increaseHealth(int amount)	Increases the health of the Player by a certain amount.
void	setHealth(int health)	Sets the health of the Player.
String	toString()

Methods inherited from class org.progettoedids.entities.Entity

getName, getSystemName, getUUID, setName

Methods inherited from class java.lang.Object

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

Field Details

inventory

protected Inventory inventory

Constructor Details

Player

protected Player(String systemName,
 String name,
 int health,
 Inventory inventory)

Initializes Player.

Parameters:

systemName - The system name is used to uniquely identify a certain type of Food. Must not be null

name - The name is displayed to the user and is used to identify an instance of Food by the user. Must not be null

health - the initial health of the Player. Must be positive

inventory - the inventory of the Player. Must not be null

Method Details

getInventory

public Inventory getInventory()

Returns the inventory of the Player.

Returns:

the Inventory object of the Player

getHealth

public int getHealth()

Returns the health of the Player.

Returns:

a positive integer

setHealth

public void setHealth(int health)
               throws DeathException

Sets the health of the Player.

Parameters:

health - the new health of the Player. Must be a positive or zero

Throws:

DeathException - if the new health is set to zero

increaseHealth

public void increaseHealth(int amount)

Increases the health of the Player by a certain amount.

Parameters:

amount - the amount of health to add to the player. Must be positive or zero

Throws:

IllegalArgumentException - if the amount passed as an argument is negative

decreaseHealth

public void decreaseHealth(int amount)
                    throws DeathException

Decreases the health of the Player by a certain amount.

Parameters:

amount - the amount of health to remove from the player. Must be positive or zero

Throws:

IllegalArgumentException - if the amount passed as an argument is negative

DeathException - if the health of the Player reaches or goes below zero

toString

public String toString()

Overrides:

toString in class Entity