Package com.csse3200.game.components

Class StaminaComponent

java.lang.Object

com.csse3200.game.components.Component

com.csse3200.game.components.StaminaComponent

public class StaminaComponent
extends Component

StaminaComponent - resource manager for player stamina.

Field Summary

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

enabled, entity

Constructor Summary

Constructors

Constructor	Description
StaminaComponent(float maxStamina, float staminaRegenPerSecond, float sprintDrainPerSecond, int attackStaminaCost)
StaminaComponent(float maxStamina, float staminaRegenPerSecond, float sprintDrainPerSecond, int attackStaminaCost, float regenDelaySeconds)

Method Summary

Modifier and Type	Method	Description
void	create()	Called when the entity is created and registered.
static StaminaComponent	fromConfig(Object cfg)
int	getCurrentStamina()
int	getMaxStamina()
boolean	isExhausted()
void	setCurrentStamina(int value)
void	setSprinting(boolean sprinting)
void	tick(float dt)
boolean	tryConsumeForAttack()
void	update()	Called once per frame of the game, and should be used for most component logic.
void	update(float dt)

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

StaminaComponent

public StaminaComponent(float maxStamina,
 float staminaRegenPerSecond,
 float sprintDrainPerSecond,
 int attackStaminaCost,
 float regenDelaySeconds)

StaminaComponent

public StaminaComponent(float maxStamina,
 float staminaRegenPerSecond,
 float sprintDrainPerSecond,
 int attackStaminaCost)

Method Details

create

public void create()

Description copied from class: Component

Called when the entity is created and registered. Initial logic such as calls to GetComponent should be made here, not in the constructor which is called before an entity is finished.

Overrides:

create in class Component

update

public void update(float dt)

update

public void update()

Description copied from class: Component

Called once per frame of the game, and should be used for most component logic. Not called if component is disabled.

Overrides:

update in class Component

tick

public void tick(float dt)

tryConsumeForAttack

public boolean tryConsumeForAttack()

setSprinting

public void setSprinting(boolean sprinting)

getCurrentStamina

public int getCurrentStamina()

getMaxStamina

public int getMaxStamina()

isExhausted

public boolean isExhausted()

setCurrentStamina

public void setCurrentStamina(int value)

fromConfig

public static StaminaComponent fromConfig(Object cfg)