Protected Member Functions
void	StaminaHandler (PlayerBase player)

void	Init ()

void	ActivateDepletionModifier (EStaminaMultiplierTypes type)

void	DeactivateDepletionModifier (EStaminaMultiplierTypes type)

void	RecalculateDepletionMultiplier ()

void	ActivateRecoveryModifier (EStaminaMultiplierTypes type)

void	DeactivateRecoveryModifier (EStaminaMultiplierTypes type)

void	RecalculateRecoveryMultiplier ()

void	Update (float deltaT, int pCurrentCommandID)

void	OnRPC (float stamina, float stamina_cap, bool cooldown)
	deprecated use, StaminaHandler uses SyncJunctures now

void	OnSyncJuncture (int pJunctureID, ParamsReadContext pCtx)
	called from PlayerBase - syncs stamina values on server with client AND sets the value to match on server and client both (m_StaminaSynced guarantees identical values)

void	StaminaProcessor_Move (HumanMovementState pHumanMovementState)

void	StaminaProcessor_Ladder (HumanMovementState pHumanMovementState)

void	StaminaProcessor_Swimming (HumanMovementState pHumanMovementState)

void	SyncStamina (float stamina, float stamina_cap, bool cooldown)
	stamina sync - server part

void	SyncAdditionalStaminaInfo (Param par)
	Method to sync more info for stamina manager. Template parameter means it is very extendable for further use.

void	ReadAdditionalStaminaInfo (ParamsReadContext pCtx)
	Order of read parameters must match the order of writing above.

void	RegisterStaminaConsumers ()

void	RegisterStaminaModifiers ()

float	CalcStaminaGainBonus ()
	Calulates stamina regain bonus coef based on current stamina cap and level.

void	ApplyExhaustion ()

void	CheckStaminaState ()
	check if the stamina is completely depleted

void	SetCooldown (float time, int modifier=-1)
	set cooldown timer between each consume of stamina

void	ResetCooldown (int modifier=-1)

Timer	GetCooldownTimer (int modifier)

bool	HasEnoughStaminaFor (EStaminaConsumers consumer)

bool	HasEnoughStaminaToStart (EStaminaConsumers consumer)

void	SetStamina (float stamina_value)

float	GetStamina ()

float	GetStaminaNormalized ()

float	GetSyncedStamina ()

float	GetSyncedStaminaNormalized ()

float	GetStaminaCap ()

float	GetStaminaMax ()

void	SetDepletionMultiplier (float val)

void	SetRecoveryMultiplier (float val)

float	GetDepletionMultiplier ()

float	GetRecoveryMultiplier ()

void	DepleteStaminaEx (EStaminaModifiers modifier, float dT=-1, float coef=1.0)

void	DepleteStamina (EStaminaModifiers modifier, float dT=-1)
	Deprecated.

Protected Attributes
float	m_PlayerLoad

float	m_StaminaDelta

float	m_Stamina

float	m_StaminaSynced

float	m_StaminaCap

float	m_StaminaDepletion

float	m_StaminaDepletionMultiplier

float	m_StaminaRecoveryMultiplier

float	m_Time

ref Param3< float, float, bool >	m_StaminaParams

ref HumanMovementState	m_State

SHumanCommandMoveSettings	m_HumanMoveSettings

PlayerBase	m_Player

bool	m_Debug

bool	m_StaminaDepleted
	DEPRECATED.

ref map< int, ref Timer >	m_TimerMap

ref map< EStaminaMultiplierTypes, float >	m_RegisteredDepletionModifiers

ref set< EStaminaMultiplierTypes >	m_ActiveDepletionModifiers

ref map< EStaminaMultiplierTypes, float >	m_RegisteredRecoveryModifiers

ref set< EStaminaMultiplierTypes >	m_ActiveRecoveryModifiers

bool	m_IsInCooldown

ref StaminaConsumers	m_StaminaConsumers

ref StaminaModifiers	m_StaminaModifiers

Detailed Description

Definition at line 260 of file staminahandler.c.

Constructor & Destructor Documentation

◆ StaminaHandler()

void StaminaHandler::StaminaHandler ( PlayerBase player )

protected

Definition at line 295 of file staminahandler.c.

Member Function Documentation

◆ ActivateDepletionModifier()

void StaminaHandler::ActivateDepletionModifier ( EStaminaMultiplierTypes type )

protected

Definition at line 348 of file staminahandler.c.

◆ ActivateRecoveryModifier()

void StaminaHandler::ActivateRecoveryModifier ( EStaminaMultiplierTypes type )

protected

Definition at line 384 of file staminahandler.c.

◆ ApplyExhaustion()

void StaminaHandler::ApplyExhaustion ( )

protected

sets exhaustion look of player based on stamina level

Definition at line 808 of file staminahandler.c.

◆ CalcStaminaGainBonus()

float StaminaHandler::CalcStaminaGainBonus ( )

protected

Calulates stamina regain bonus coef based on current stamina cap and level.

Definition at line 797 of file staminahandler.c.

◆ CheckStaminaState()

void StaminaHandler::CheckStaminaState ( )

protected

check if the stamina is completely depleted

in case of complete depletion - start a cooldown timer before the regeneration cycle start

Definition at line 835 of file staminahandler.c.

◆ DeactivateDepletionModifier()

void StaminaHandler::DeactivateDepletionModifier ( EStaminaMultiplierTypes type )

protected

Definition at line 361 of file staminahandler.c.

◆ DeactivateRecoveryModifier()

void StaminaHandler::DeactivateRecoveryModifier ( EStaminaMultiplierTypes type )

protected

Definition at line 398 of file staminahandler.c.

◆ DepleteStamina()

void StaminaHandler::DepleteStamina	(	EStaminaModifiers	modifier,
		float	dT = -1 )

protected

Deprecated.

Definition at line 1063 of file staminahandler.c.

◆ DepleteStaminaEx()

void StaminaHandler::DepleteStaminaEx	(	EStaminaModifiers	modifier,
		float	dT = -1,
		float	coef = 1.0 )

protected

run cooldown right after depletion

Definition at line 971 of file staminahandler.c.

◆ GetCooldownTimer()

Timer StaminaHandler::GetCooldownTimer ( int modifier )

protected

Definition at line 892 of file staminahandler.c.

◆ GetDepletionMultiplier()

float StaminaHandler::GetDepletionMultiplier ( )

protected

Definition at line 961 of file staminahandler.c.

◆ GetRecoveryMultiplier()

float StaminaHandler::GetRecoveryMultiplier ( )

protected

Definition at line 966 of file staminahandler.c.

◆ GetStamina()

float StaminaHandler::GetStamina ( )

protected

Definition at line 914 of file staminahandler.c.

◆ GetStaminaCap()

float StaminaHandler::GetStaminaCap ( )

protected

Definition at line 934 of file staminahandler.c.

◆ GetStaminaMax()

float StaminaHandler::GetStaminaMax ( )

protected

Definition at line 939 of file staminahandler.c.

◆ GetStaminaNormalized()

float StaminaHandler::GetStaminaNormalized ( )

protected

Definition at line 919 of file staminahandler.c.

◆ GetSyncedStamina()

float StaminaHandler::GetSyncedStamina ( )

protected

Definition at line 924 of file staminahandler.c.

◆ GetSyncedStaminaNormalized()

float StaminaHandler::GetSyncedStaminaNormalized ( )

protected

Definition at line 929 of file staminahandler.c.

◆ HasEnoughStaminaFor()

bool StaminaHandler::HasEnoughStaminaFor ( EStaminaConsumers consumer )

protected

Definition at line 898 of file staminahandler.c.

◆ HasEnoughStaminaToStart()

bool StaminaHandler::HasEnoughStaminaToStart ( EStaminaConsumers consumer )

protected

Definition at line 903 of file staminahandler.c.

◆ Init()

void StaminaHandler::Init ( )

protected

Definition at line 330 of file staminahandler.c.

◆ OnRPC()

void StaminaHandler::OnRPC	(	float	stamina,
		float	stamina_cap,
		bool	cooldown )

protected

deprecated use, StaminaHandler uses SyncJunctures now

Definition at line 516 of file staminahandler.c.

◆ OnSyncJuncture()

void StaminaHandler::OnSyncJuncture	(	int	pJunctureID,
		ParamsReadContext	pCtx )

protected

called from PlayerBase - syncs stamina values on server with client AND sets the value to match on server and client both (m_StaminaSynced guarantees identical values)

Definition at line 521 of file staminahandler.c.

◆ ReadAdditionalStaminaInfo()

void StaminaHandler::ReadAdditionalStaminaInfo ( ParamsReadContext pCtx )

protected

Order of read parameters must match the order of writing above.

Definition at line 695 of file staminahandler.c.

◆ RecalculateDepletionMultiplier()

void StaminaHandler::RecalculateDepletionMultiplier ( )

protected

Definition at line 371 of file staminahandler.c.

◆ RecalculateRecoveryMultiplier()

void StaminaHandler::RecalculateRecoveryMultiplier ( )

protected

Definition at line 408 of file staminahandler.c.

◆ RegisterStaminaConsumers()

void StaminaHandler::RegisterStaminaConsumers ( )

protected

Definition at line 708 of file staminahandler.c.

◆ RegisterStaminaModifiers()

void StaminaHandler::RegisterStaminaModifiers ( )

protected

Definition at line 749 of file staminahandler.c.

◆ ResetCooldown()

void StaminaHandler::ResetCooldown ( int modifier = -1 )

protected

Definition at line 878 of file staminahandler.c.

◆ SetCooldown()

void StaminaHandler::SetCooldown	(	float	time,
		int	modifier = -1 )

protected

set cooldown timer between each consume of stamina

Definition at line 854 of file staminahandler.c.

◆ SetDepletionMultiplier()

void StaminaHandler::SetDepletionMultiplier ( float val )

protected

Definition at line 945 of file staminahandler.c.

◆ SetRecoveryMultiplier()

void StaminaHandler::SetRecoveryMultiplier ( float val )

protected

Definition at line 953 of file staminahandler.c.

◆ SetStamina()

void StaminaHandler::SetStamina ( float stamina_value )

protected

Definition at line 908 of file staminahandler.c.

◆ StaminaProcessor_Ladder()

void StaminaHandler::StaminaProcessor_Ladder ( HumanMovementState pHumanMovementState )

protected

Definition at line 621 of file staminahandler.c.

◆ StaminaProcessor_Move()

void StaminaHandler::StaminaProcessor_Move ( HumanMovementState pHumanMovementState )

protected

Definition at line 558 of file staminahandler.c.

◆ StaminaProcessor_Swimming()

void StaminaHandler::StaminaProcessor_Swimming ( HumanMovementState pHumanMovementState )

protected

Definition at line 646 of file staminahandler.c.

◆ SyncAdditionalStaminaInfo()

void StaminaHandler::SyncAdditionalStaminaInfo ( Param par )

protected

Method to sync more info for stamina manager. Template parameter means it is very extendable for further use.

Definition at line 684 of file staminahandler.c.

◆ SyncStamina()

void StaminaHandler::SyncStamina	(	float	stamina,
		float	stamina_cap,
		bool	cooldown )

protected

stamina sync - server part

Definition at line 673 of file staminahandler.c.

◆ Update()

void StaminaHandler::Update	(	float	deltaT,
		int	pCurrentCommandID )

protected

gets the actual players load

StaminaCap calculation starts when PlayerLoad exceeds STAMINA_WEIGHT_LIMIT_THRESHOLD

processed on event

Definition at line 423 of file staminahandler.c.

Member Data Documentation

◆ m_ActiveDepletionModifiers

ref set<EStaminaMultiplierTypes> StaminaHandler::m_ActiveDepletionModifiers

protected

Definition at line 281 of file staminahandler.c.

◆ m_ActiveRecoveryModifiers

ref set<EStaminaMultiplierTypes> StaminaHandler::m_ActiveRecoveryModifiers

protected

Definition at line 284 of file staminahandler.c.

◆ m_Debug

bool StaminaHandler::m_Debug

protected

Definition at line 276 of file staminahandler.c.

◆ m_HumanMoveSettings

SHumanCommandMoveSettings StaminaHandler::m_HumanMoveSettings

protected

Definition at line 273 of file staminahandler.c.

◆ m_IsInCooldown

bool StaminaHandler::m_IsInCooldown

protected

Definition at line 286 of file staminahandler.c.

◆ m_Player

PlayerBase StaminaHandler::m_Player

protected

Definition at line 274 of file staminahandler.c.

◆ m_PlayerLoad

float StaminaHandler::m_PlayerLoad

protected

Definition at line 262 of file staminahandler.c.

◆ m_RegisteredDepletionModifiers

ref map<EStaminaMultiplierTypes, float> StaminaHandler::m_RegisteredDepletionModifiers

protected

Definition at line 280 of file staminahandler.c.

◆ m_RegisteredRecoveryModifiers

ref map<EStaminaMultiplierTypes, float> StaminaHandler::m_RegisteredRecoveryModifiers

protected

Definition at line 283 of file staminahandler.c.

◆ m_Stamina

float StaminaHandler::m_Stamina

protected

Definition at line 264 of file staminahandler.c.

◆ m_StaminaCap

float StaminaHandler::m_StaminaCap

protected

Definition at line 266 of file staminahandler.c.

◆ m_StaminaConsumers

ref StaminaConsumers StaminaHandler::m_StaminaConsumers

protected

Definition at line 288 of file staminahandler.c.

◆ m_StaminaDelta

float StaminaHandler::m_StaminaDelta

protected

Definition at line 263 of file staminahandler.c.

◆ m_StaminaDepleted

bool StaminaHandler::m_StaminaDepleted

protected

DEPRECATED.

Definition at line 277 of file staminahandler.c.

◆ m_StaminaDepletion

float StaminaHandler::m_StaminaDepletion

protected

Definition at line 267 of file staminahandler.c.

◆ m_StaminaDepletionMultiplier

float StaminaHandler::m_StaminaDepletionMultiplier

protected

Definition at line 268 of file staminahandler.c.

◆ m_StaminaModifiers

ref StaminaModifiers StaminaHandler::m_StaminaModifiers

protected

Definition at line 289 of file staminahandler.c.

◆ m_StaminaParams

ref Param3<float,float,bool> StaminaHandler::m_StaminaParams

protected

Definition at line 271 of file staminahandler.c.

◆ m_StaminaRecoveryMultiplier

float StaminaHandler::m_StaminaRecoveryMultiplier

protected

Definition at line 269 of file staminahandler.c.

◆ m_StaminaSynced

float StaminaHandler::m_StaminaSynced

protected

Definition at line 265 of file staminahandler.c.

◆ m_State

ref HumanMovementState StaminaHandler::m_State

protected

Definition at line 272 of file staminahandler.c.

◆ m_Time

float StaminaHandler::m_Time

protected

Definition at line 270 of file staminahandler.c.

◆ m_TimerMap

ref map<int,ref Timer> StaminaHandler::m_TimerMap

protected

Definition at line 279 of file staminahandler.c.

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

Daten/4_world/classes/staminahandler.c

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ StaminaHandler()

Member Function Documentation

◆ ActivateDepletionModifier()

◆ ActivateRecoveryModifier()

◆ ApplyExhaustion()

◆ CalcStaminaGainBonus()

◆ CheckStaminaState()

◆ DeactivateDepletionModifier()

◆ DeactivateRecoveryModifier()

◆ DepleteStamina()

◆ DepleteStaminaEx()

◆ GetCooldownTimer()

◆ GetDepletionMultiplier()

◆ GetRecoveryMultiplier()

◆ GetStamina()

◆ GetStaminaCap()

◆ GetStaminaMax()

◆ GetStaminaNormalized()

◆ GetSyncedStamina()

◆ GetSyncedStaminaNormalized()

◆ HasEnoughStaminaFor()

◆ HasEnoughStaminaToStart()

◆ Init()

◆ OnRPC()

◆ OnSyncJuncture()

◆ ReadAdditionalStaminaInfo()

◆ RecalculateDepletionMultiplier()

◆ RecalculateRecoveryMultiplier()

◆ RegisterStaminaConsumers()

◆ RegisterStaminaModifiers()

◆ ResetCooldown()

◆ SetCooldown()

◆ SetDepletionMultiplier()

◆ SetRecoveryMultiplier()

◆ SetStamina()

◆ StaminaProcessor_Ladder()

◆ StaminaProcessor_Move()

◆ StaminaProcessor_Swimming()

◆ SyncAdditionalStaminaInfo()

◆ SyncStamina()

◆ Update()

Member Data Documentation

◆ m_ActiveDepletionModifiers

◆ m_ActiveRecoveryModifiers

◆ m_Debug

◆ m_HumanMoveSettings

◆ m_IsInCooldown

◆ m_Player

◆ m_PlayerLoad

◆ m_RegisteredDepletionModifiers

◆ m_RegisteredRecoveryModifiers

◆ m_Stamina

◆ m_StaminaCap

◆ m_StaminaConsumers

◆ m_StaminaDelta

◆ m_StaminaDepleted

◆ m_StaminaDepletion

◆ m_StaminaDepletionMultiplier

◆ m_StaminaModifiers

◆ m_StaminaParams

◆ m_StaminaRecoveryMultiplier

◆ m_StaminaSynced

◆ m_State

◆ m_Time

◆ m_TimerMap