Package com.deco2800.game.components.combatitemscomponents

Class WeaponStatsComponent

java.lang.Object

com.deco2800.game.components.Component

com.deco2800.game.components.combatitemscomponents.WeaponStatsComponent

Direct Known Subclasses:

AreaOfEffectStatsComponent, PhysicalWeaponStatsComponent

public abstract class WeaponStatsComponent
extends Component

Component used to store information and methods related to combat such as health, attack, etc. Any entities which engage it combat should have an instance of this class registered. This class can be extended for more specific combat needs.

Field Summary

Fields

Modifier and Type	Field	Description
protected double	coolDown
protected double	damage
protected Map<Materials,Integer>	materials

Fields inherited from class com.deco2800.game.components.Component

enabled, entity

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WeaponStatsComponent(double damage, double coolDown, Map<Materials,Integer> materials, String description)

Method Summary

Modifier and Type	Method	Description
double	getCoolDown()	Returns the cooldown of the weapon
double	getDamage()	Returns the damage of the weapon
String	getDescription()	Returns the weapon description
Map<Materials,Integer>	getMaterials()	Returns the materials required to craft the weapon
void	setCoolDown(double coolDown)	Sets the cooldown of the weapon
void	setDamage(double damage)	Sets the damage of the weapon
void	setDescription(String description)	Sets the description of the weapon
void	setMaterials(Map<Materials,Integer> materials)	Sets the materials required to craft the weapon

Methods inherited from class com.deco2800.game.components.Component

create, dispose, earlyUpdate, getEntity, setEnabled, setEntity, toString, triggerEarlyUpdate, triggerUpdate, update

Methods inherited from class java.lang.Object

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

Field Details

damage

protected double damage

coolDown

protected double coolDown

materials

protected Map<Materials,Integer> materials

Constructor Details

WeaponStatsComponent

protected WeaponStatsComponent(double damage,
 double coolDown,
 Map<Materials,Integer> materials,
 String description)

Parameters:

damage - damage of the weapon

coolDown - duration before the next attack instance can be called

materials - materials needed to craft the weapon

Method Details

getDamage

public double getDamage()

Returns the damage of the weapon

Returns:

damage of the weapon

getCoolDown

public double getCoolDown()

Returns the cooldown of the weapon

Returns:

duration before the next attack instance can be called

setDamage

public void setDamage(double damage)

Sets the damage of the weapon

Parameters:

damage - damage of the weapon

setCoolDown

public void setCoolDown(double coolDown)

Sets the cooldown of the weapon

Parameters:

coolDown - duration before the next attack instance can be called

setDescription

public void setDescription(String description)

Sets the description of the weapon

Parameters:

description - description of the weapon

setMaterials

public void setMaterials(Map<Materials,Integer> materials)

Sets the materials required to craft the weapon

Parameters:

materials - materials needed to craft the weapon

getDescription

public String getDescription()

Returns the weapon description

Returns:

description of the weapon

getMaterials

public Map<Materials,Integer> getMaterials()

Returns the materials required to craft the weapon

Returns:

materials needed to craft the weapon