StaminaModifiers Class Reference

Private Member Functions
void	StaminaModifiers ()
void	RegisterFixed (EStaminaModifiers modifier, float value, float cooldown=GameConstants.STAMINA_REGEN_COOLDOWN_DEPLETION)
	register single value modifier - depletes stamina for that value
void	RegisterRandomized (EStaminaModifiers modifier, float minValue, float maxValue, float cooldown=GameConstants.STAMINA_REGEN_COOLDOWN_DEPLETION)
	register randomized modifier - stamina will be depleted by value between min and max value;
void	RegisterLinear (EStaminaModifiers modifier, float startValue, float endValue, float startTime, float duration, float cooldown=GameConstants.STAMINA_REGEN_COOLDOWN_DEPLETION)
	register lerped modifier - depletes stamina for startValue, and, after a startTime, lerps to endValue over duration
void	RegisterExponential (EStaminaModifiers modifier, float startValue, float exponent, float startTime, float duration, float cooldown=GameConstants.STAMINA_REGEN_COOLDOWN_DEPLETION)
	register exponential modifier - depletes stamina for startValue, and, after a startTime, lerps from 0 to exponent over duration
StaminaModifier	GetModifierData (EStaminaModifiers modifier)

Private Attributes
const int	FIXED = 0
const int	RANDOMIZED = 1
const int	LINEAR = 2
const int	EXPONENTIAL = 3
protected ref map< EStaminaModifiers, ref StaminaModifier >	m_StaminaModifiers

Constructor & Destructor Documentation

StaminaModifiers()

void StaminaModifiers ( )

inlineprivate

References m_StaminaModifiers.

Member Function Documentation

GetModifierData()

StaminaModifier GetModifierData ( EStaminaModifiers  modifier )

inlineprivate

References m_StaminaModifiers.

Referenced by DepleteStamina(), and ResetCooldown().

RegisterExponential()

void RegisterExponential ( EStaminaModifiers  modifier, float  startValue, float  exponent, float  startTime, float  duration, float  cooldown = GameConstants.STAMINA_REGEN_COOLDOWN_DEPLETION  )

inlineprivate

register exponential modifier - depletes stamina for startValue, and, after a startTime, lerps from 0 to exponent over duration

References EXPONENTIAL, m_StaminaModifiers, and StaminaModifier().

Referenced by RegisterStaminaModifiers().

RegisterFixed()

void RegisterFixed ( EStaminaModifiers  modifier, float  value, float  cooldown = GameConstants.STAMINA_REGEN_COOLDOWN_DEPLETION  )

inlineprivate

register single value modifier - depletes stamina for that value

init of StaminaModifier - type and min, max values (min is not relevant for that type)

References FIXED, m_StaminaModifiers, and StaminaModifier().

Referenced by RegisterStaminaModifiers().

RegisterLinear()

void RegisterLinear ( EStaminaModifiers  modifier, float  startValue, float  endValue, float  startTime, float  duration, float  cooldown = GameConstants.STAMINA_REGEN_COOLDOWN_DEPLETION  )

inlineprivate

register lerped modifier - depletes stamina for startValue, and, after a startTime, lerps to endValue over duration

References LINEAR, m_StaminaModifiers, and StaminaModifier().

RegisterRandomized()

void RegisterRandomized ( EStaminaModifiers  modifier, float  minValue, float  maxValue, float  cooldown = GameConstants.STAMINA_REGEN_COOLDOWN_DEPLETION  )

inlineprivate

register randomized modifier - stamina will be depleted by value between min and max value;

init of StaminaModifier - type, min, max values

References m_StaminaModifiers, RANDOMIZED, and StaminaModifier().

Referenced by RegisterStaminaModifiers().

Field Documentation

EXPONENTIAL

const int EXPONENTIAL = 3

private

Referenced by DepleteStamina(), and RegisterExponential().

FIXED

const int FIXED = 0

private

Referenced by DepleteStamina(), and RegisterFixed().

LINEAR

const int LINEAR = 2

private

Referenced by DepleteStamina(), and RegisterLinear().

m_StaminaModifiers

protected ref map<EStaminaModifiers, ref StaminaModifier> m_StaminaModifiers

private

Referenced by GetModifierData(), RegisterExponential(), RegisterFixed(), RegisterLinear(), RegisterRandomized(), and StaminaModifiers().

RANDOMIZED

const int RANDOMIZED = 1

private

Referenced by DepleteStamina(), and RegisterRandomized().

---

The documentation for this class was generated from the following file:

• 4_World/Classes/StaminaHandler.c