Inheritance diagram for CharacterStaminaComponent:

Public Member Functions
proto external float	GetBreathProgress ()
	Returns breath progress as <0,1>.

proto external float	GetBreathFrequency ()
	Returns current breath frequency.

proto external float	GetBreathMagnitude ()
	Returns current breath magnitude.

proto external void	AddStamina (float pStamina)
	Adds stamina, in range 0-1.

void	OnStaminaDrain (float pDrain)
	Runs every time stamina value has changed.

Public Member Functions inherited from BaseStaminaComponent
proto external IEntity	GetOwner ()

proto external float	GetStamina ()
	Get the current stamina value <0..1>.

Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Member Function Documentation

◆ AddStamina()

proto external void CharacterStaminaComponent.AddStamina ( float pStamina )

Adds stamina, in range 0-1.

Can accept negative values. Has to be run on owner

Parameters

pStamina How much stamina should be changed.

proto external float CharacterStaminaComponent.GetBreathFrequency ( )

Returns current breath frequency.

Returns: Returns the frequency, i.e. amount of full breaths taken per second.

proto external float CharacterStaminaComponent.GetBreathMagnitude ( )

Returns current breath magnitude.

proto external float CharacterStaminaComponent.GetBreathProgress ( )

Returns breath progress as <0,1>.

Progress goes from 0 to 1 then back to 0.

Returns: Returns breath progress as a value <0,1> where 0 is breath out, 1 is breath in.

void CharacterStaminaComponent.OnStaminaDrain ( float pDrain )

Runs every time stamina value has changed.

Parameters

pDrain How much stamina has recovered/drained.

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