Package org.progettoedids.entities.items.weapons

Class Weapon

java.lang.Object

org.progettoedids.entities.Entity

org.progettoedids.entities.items.Item

org.progettoedids.entities.items.weapons.Weapon

Direct Known Subclasses:

BrokenSword, FancySword, Rock

public abstract class Weapon
extends Item

A Weapon is an instance of an Item additionally characterized by the damage the Weapon can deal and its usability level which represents the maximum amount of times the Weapon can be used.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	damage
protected int	usabilityLevel

Fields inherited from class org.progettoedids.entities.items.Item

weight

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Weapon(String systemName, String name, int weight, int damage, int usabilityLevel)	Initializes a Weapon.

Method Summary

Modifier and Type	Method	Description
boolean	canBeCollected()	Returns whether the Weapon can be collected from a Room of the Labyrinth
int	decreaseUsabilityLevel()	Decreases the usability level of the weapon by one.
int	getDamage()	Returns the amount of damage the Weapon deals on each attack
int	getUsabilityLevel()	Returns the current usability level of the Weapon.
String	toString()

Methods inherited from class org.progettoedids.entities.items.Item

getWeight

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

damage

protected int damage

usabilityLevel

protected int usabilityLevel

Constructor Details

Weapon

protected Weapon(String systemName,
 String name,
 int weight,
 int damage,
 int usabilityLevel)

Initializes a Weapon.

Parameters:

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

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

weight - The weight of the Weapon. It must be a positive or zero integer

damage - The amount of damage dealt by a single use of the Weapon. Must be a positive or zero integer

usabilityLevel - The amount of times the Weapon can be used. Must be a positive integer

Method Details

canBeCollected

public boolean canBeCollected()

Returns whether the Weapon can be collected from a Room of the Labyrinth

Specified by:

canBeCollected in class Item

Returns:

Always true, unless overridden in a subclass

getDamage

public int getDamage()

Returns the amount of damage the Weapon deals on each attack

Returns:

The amount of damage

getUsabilityLevel

public int getUsabilityLevel()

Returns the current usability level of the Weapon.

Returns:

The usability level of the Weapon

decreaseUsabilityLevel

public int decreaseUsabilityLevel()
                           throws ExhaustedUsabilityException

Decreases the usability level of the weapon by one.

Returns:

The new usability level after the decrement

Throws:

ExhaustedUsabilityException - when the weapon is completely worn

toString

public String toString()

Overrides:

toString in class Item