SCR_HitZone Class Reference

Inheritance diagram for SCR_HitZone:

Protected Member Functions
EHitZoneGroup	GetHitZoneGroup ()
ScriptInvokerVoid	GetOnHealthChanged (bool createNew=true)
ScriptInvoker	GetOnDamageStateChanged (bool createNew=true)
IEntity	GetOwner ()
void	OnHealthSet ()
void	OnDamageStateChanged (EDamageState newState, EDamageState previousDamageState, bool isJIP)
	Called when the damage state changes.
override float	ComputeEffectiveDamage (notnull BaseDamageContext damageContext, bool isDOT)
void	ApplyDamagePassRules (notnull BaseDamageContext damageContext)

Protected Attributes
ref array< ref SCR_BaseDamagePassRule >	m_aDamagePassRules
ref ScriptInvokerVoid	m_OnHealthChanged
ref ScriptInvoker	m_OnDamageStateChanged

Detailed Description

Definition at line 1 of file SCR_HitZone.c.

Member Function Documentation

ApplyDamagePassRules()

void SCR_HitZone::ApplyDamagePassRules ( notnull BaseDamageContext damageContext )

inlineprotected

Pass damage based damage context and rules specified in hitzone configuration
Receiving hitzones also have to inherit from SCR_HitZone

! param[in] damageContext - Damage context coming from HijackDamageHandling

Definition at line 107 of file SCR_HitZone.c.

ComputeEffectiveDamage()

override float SCR_HitZone::ComputeEffectiveDamage ( notnull BaseDamageContext damageContext, bool isDOT )

inlineprotected

Definition at line 67 of file SCR_HitZone.c.

GetHitZoneGroup()

EHitZoneGroup SCR_HitZone::GetHitZoneGroup ( )

inlineprotected

Hit zone group getter to be overridden

Returns

Hit zone group

Definition at line 12 of file SCR_HitZone.c.

GetOnDamageStateChanged()

ScriptInvoker SCR_HitZone::GetOnDamageStateChanged ( bool createNew = true )

inlineprotected

Get event called when hitzone damage state changes.

Returns

Script invoker

Definition at line 32 of file SCR_HitZone.c.

GetOnHealthChanged()

ScriptInvokerVoid SCR_HitZone::GetOnHealthChanged ( bool createNew = true )

inlineprotected

Get event called when hitzone damage changes.

Parameters

createNew

only create a script invoker if this is set to true

Returns

Script invoker

Definition at line 21 of file SCR_HitZone.c.

GetOwner()

IEntity SCR_HitZone::GetOwner ( )

inlineprotected

Returns

Owner entity of the HitZone

Definition at line 42 of file SCR_HitZone.c.

OnDamageStateChanged()

void SCR_HitZone::OnDamageStateChanged ( EDamageState newState, EDamageState previousDamageState, bool isJIP )

inlineprotected

Called when the damage state changes.

Definition at line 60 of file SCR_HitZone.c.

OnHealthSet()

void SCR_HitZone::OnHealthSet ( )

inlineprotected

Definition at line 52 of file SCR_HitZone.c.

Member Data Documentation

m_aDamagePassRules

ref array<ref SCR_BaseDamagePassRule> SCR_HitZone::m_aDamagePassRules

protected

Definition at line 4 of file SCR_HitZone.c.

m_OnDamageStateChanged

ref ScriptInvoker SCR_HitZone::m_OnDamageStateChanged

protected

Definition at line 7 of file SCR_HitZone.c.

m_OnHealthChanged

ref ScriptInvokerVoid SCR_HitZone::m_OnHealthChanged

protected

Definition at line 6 of file SCR_HitZone.c.

---

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

• scripts/Game/HitZone/SCR_HitZone.c