Inheritance diagram for SCR_RegeneratingHitZone:

[legend]

Public Member Functions
float	CalculatePassiveRegenDPS (bool considerRegenScale=true)
	Returns the desired regeneration speed in damage per second for this hitzone.

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)
	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.

Public Member Functions inherited from SCR_HitZone
EHitZoneGroup	GetHitZoneGroup ()
	Hit zone group getter to be overridden.

ScriptInvokerVoid	GetOnHealthChanged (bool createNew=true)
	Get event called when hitzone damage changes.

ScriptInvoker	GetOnDamageStateChanged (bool createNew=true)
	Get event called when hitzone damage state changes.

IEntity	GetOwner ()

override float	ComputeEffectiveDamage (notnull BaseDamageContext damageContext, bool isDOT)
	Calculates the amount of damage a hitzone will receive.

void	DrawDebug ()

void	ApplyDamagePassRules (notnull BaseDamageContext damageContext)

void	HandlePassedDamage (notnull BaseDamageContext damageContext)

Public Member Functions inherited from HitZone
proto external float	GetBaseDamageMultiplier ()

proto external bool	HasColliderNodes ()

proto external int	GetColliderDescriptorIndex (int colliderID)

proto external float	GetDamageMultiplier (EDamageType dmgType)

proto external float	GetDamageReduction ()

proto external float	GetDamageThreshold ()

proto external int	GetAllColliderNames (out notnull array< string > colliderNames)

proto external void	SetDamageOverTime (EDamageType dmgType, float dps)
	Sets damage over time for this particular hitzone.

proto external float	GetDamageOverTime (EDamageType dmgType)

proto external int	GetNumColliderDescriptors ()

proto external HitZoneContainerComponent	GetHitZoneContainer ()

proto external void	SetHealth (float health)

proto external void	SetHealthScaled (float health)

proto external void	SetMaxHealth (float maxHealth, ESetMaxHealthFlags flag=ESetMaxHealthFlags.NONE)

proto external float	GetHealth ()

proto external float	GetHealthScaled ()

proto external float	GetDamageStateThreshold (EDamageState damageState)

proto external float	GetMaxHealth ()

proto external string	GetName ()

proto external EDamageState	GetDamageState ()

proto external float	GetCriticalDamageThreshold ()

proto external EDamageState	GetPreviousDamageState ()

proto external void	HandleDamage (float damage, int damageType, IEntity instigator)

proto external bool	IsProxy ()

proto external int	GetColliderIDs (out notnull array< int > outIDs)
	Returns all collider IDs attached to this hitzone.

proto bool	TryGetColliderDescription (IEntity owner, int descIndex, out vector transformLS[4], out int boneIndex, out int nodeID)

proto bool	TryGetColliderDescriptionFromName (IEntity owner, string colliderName, out vector transformLS[4], out int boneIndex, out int nodeID)

void	OnInit (IEntity pOwnerEntity, GenericComponent pManagerComponent)
	Call OnInit method from script.

void	OnDamage (notnull BaseDamageContext damageContext)
	Called when the damage has been dealt by the server, doesn't get called for DOT.

float	ComputeEffectiveDamage (notnull BaseDamageContext damageContext, bool isDOT)
	Calculates the amount of damage a hitzone will receive.

Protected Attributes
float	m_fFullRegenerationTime

bool	m_bAutoRegenOnHealthSet = true

Protected Attributes inherited from SCR_HitZone
ref array< ref SCR_DamagePassRule >	m_aDamagePassRules

float	m_fFireMultiplier

ref ScriptInvokerVoid	m_OnHealthChanged

ref ScriptInvoker	m_OnDamageStateChanged

Additional Inherited Members
Protected Member Functions inherited from SCR_HitZone
override void	OnHealthSet ()
	Called when damage changes.

override void	OnDamageStateChanged (EDamageState newState, EDamageState previousDamageState, bool isJIP)
	Called when the damage state changes.

Protected Member Functions inherited from HitZone
void	OnHealthSet ()
	Called when damage changes.

void	OnMaxHealthChanged ()
	Called when max damage changes.

void	OnDamageStateChanged (EDamageState newState, EDamageState previousDamageState, bool isJIP)
	Called when damage state changes.

Member Function Documentation

◆ CalculatePassiveRegenDPS()

float SCR_RegeneratingHitZone.CalculatePassiveRegenDPS ( bool considerRegenScale = true )

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

◆ GetHitZoneDamageOverTime()

float SCR_RegeneratingHitZone.GetHitZoneDamageOverTime ( EDamageType targetDamageType )

Get current total damage per second of this hitZone.

◆ OnHealthSet()

override void SCR_RegeneratingHitZone.OnHealthSet ( )

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

Implements SCR_HitZone.

◆ ToggleHitZoneAutoRegenOnHealthSet()

void SCR_RegeneratingHitZone.ToggleHitZoneAutoRegenOnHealthSet ( bool doRegen )

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.

Member Data Documentation

◆ m_bAutoRegenOnHealthSet

bool SCR_RegeneratingHitZone.m_bAutoRegenOnHealthSet = true

protected

◆ m_fFullRegenerationTime

float SCR_RegeneratingHitZone.m_fFullRegenerationTime

protected

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

Game/HitZone/SCR_CharacterHitZone.c

Public Member Functions

Protected Attributes

Additional Inherited Members