SCR_RegeneratingHitZone Class Reference

Inheritance diagram for SCR_RegeneratingHitZone:

Protected Member Functions
float	CalculatePassiveRegenDPS (bool considerRegenScale=true)
float	GetHitZoneDamageOverTime (EDamageType targetDamageType)
	Get current total damage per second of this hitZone.
override void	OnHealthSet ()
	HealthSet could have decreased health, so passive regeneration is planned.
void	ToggleHitZoneAutoRegenOnHealthSet (bool doRegen)

Protected Attributes
float	m_fFullRegenerationTime
bool	m_bAutoRegenOnHealthSet = true

Detailed Description

Definition at line 66 of file SCR_CharacterHitZone.c.

Member Function Documentation

CalculatePassiveRegenDPS()

float SCR_RegeneratingHitZone::CalculatePassiveRegenDPS ( bool considerRegenScale = true )

inlineprotected

Returns the desired regeneration speed in damage per second for this hitzone

Parameters

considerRegenScale

Consider the Gamemaster tweaked modifier for the regenerationDPS in this getter

Definition at line 78 of file SCR_CharacterHitZone.c.

GetHitZoneDamageOverTime()

float SCR_RegeneratingHitZone::GetHitZoneDamageOverTime ( EDamageType targetDamageType )

inlineprotected

Get current total damage per second of this hitZone.

Definition at line 100 of file SCR_CharacterHitZone.c.

OnHealthSet()

override void SCR_RegeneratingHitZone::OnHealthSet ( )

inlineprotected

HealthSet could have decreased health, so passive regeneration is planned.

Definition at line 142 of file SCR_CharacterHitZone.c.

ToggleHitZoneAutoRegenOnHealthSet()

void SCR_RegeneratingHitZone::ToggleHitZoneAutoRegenOnHealthSet ( bool doRegen )

inlineprotected

Permanently disable/enable the automatic start of regeneration on this hitzone when manually setting it's health Use this when setting health on characters that should not heal, such as scripted gameplay events.

Definition at line 163 of file SCR_CharacterHitZone.c.

Member Data Documentation

m_bAutoRegenOnHealthSet

bool SCR_RegeneratingHitZone::m_bAutoRegenOnHealthSet = true

protected

Definition at line 71 of file SCR_CharacterHitZone.c.

m_fFullRegenerationTime

float SCR_RegeneratingHitZone::m_fFullRegenerationTime

protected

Definition at line 69 of file SCR_CharacterHitZone.c.

---

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

• scripts/Game/HitZone/SCR_CharacterHitZone.c