SCR_CharacterHeadHitZone Interface Reference

Inheritance diagram for SCR_CharacterHeadHitZone:

Public Member Functions
override void	OnInit (IEntity pOwnerEntity, GenericComponent pManagerComponent)
	Call OnInit method from script.
override void	OnDamageStateChanged (EDamageState newState, EDamageState previousDamageState, bool isJIP)
	Called when the damage state changes.
void	SoundKnockout ()
	Interrupt screaming when shot in head.
Public Member Functions inherited from SCR_CharacterHitZone
override void	OnDamage (notnull BaseDamageContext damageContext)
	Called after damage multipliers and thresholds are applied to received impacts and damage is applied to hitzone.
override float	ComputeEffectiveDamage (notnull BaseDamageContext damageContext, bool isDOT)
	Calculates the amount of damage a hitzone will receive.
float	GetArmorProtectionValue (EDamageType damageType)
	Get strength of protection from armor attribute on prefab of clothing item.
bool	IsCovered ()
	Whether hitzone submeshes are hidden with clothing.
override void	OnDamageStateChanged (EDamageState newState, EDamageState previousDamageState, bool isJIP)
	Called when the damage state changes.
void	SetWoundedSubmesh (bool wounded)
void	UpdateSubmeshes ()
	Manage wounds submeshes.
float	GetMaxBleedingRate ()
override EHitZoneGroup	GetHitZoneGroup ()
	Hit zone group getter to be overridden.
array< ref LoadoutAreaType >	GetBleedingAreas ()
EBandagingAnimationBodyParts	GetBodyPartToHeal ()
Public Member Functions inherited from SCR_RegeneratingHitZone
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.

Additional Inherited Members
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.
Protected Attributes inherited from SCR_CharacterHitZone
float	m_fBleedingRateScale
ref array< string >	m_aDamageSubmeshes
ref array< ref LoadoutAreaType >	m_aBleedingAreas
ECharacterHitZoneGroup	m_eHitZoneGroup
EBandagingAnimationBodyParts	m_eBandageAnimationBodyPart
bool	m_bIsWounded
Protected Attributes inherited from SCR_RegeneratingHitZone
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
Static Protected Attributes inherited from SCR_CharacterHitZone
static const float	DAMAGE_TO_BLOOD_MULTIPLIER = 15

Member Function Documentation

OnDamageStateChanged()

override void SCR_CharacterHeadHitZone.OnDamageStateChanged	(	EDamageState	newState,
		EDamageState	previousDamageState,
		bool	isJIP
	)

Called when the damage state changes.

Implements SCR_CharacterHitZone.

OnInit()

override void SCR_CharacterHeadHitZone.OnInit	(	IEntity	pOwnerEntity,
		GenericComponent	pManagerComponent
	)

Call OnInit method from script.

Implements HitZone.

SoundKnockout()

void SCR_CharacterHeadHitZone.SoundKnockout

(

)

Interrupt screaming when shot in head.

---

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

• Game/HitZone/SCR_CharacterHitZone.c