SCR_DotDamageArea Interface Reference

Inheritance diagram for SCR_DotDamageArea:

Public Member Functions
override void	OnAreaExit (IEntity entity)
	Callback when an entity exits this DamageArea this frame.
override void	RemoveEffect (notnull IEntity entity)
	Attempts to find and remove this effect from the entity.
Public Member Functions inherited from SCR_DamageArea
bool	IsRegisteredAutomatically ()
override void	OnAreaEntered (notnull IEntity entity)
	Callback when an entity enters this DamageArea this frame.
override void	DisplayInfo ()
Public Member Functions inherited from DamageArea
proto external IEntity	GetParent ()
	Returns parent entity of this DamageArea.
proto external BaseDamageAreaShape	GetShape ()
void	OnAreaPersisted (notnull IEntity entity)
	Callback when an entity was already inside of the area and it is still in the area this frame.

Protected Member Functions
override BaseDamageEffect	GetDamageEffect (SCR_DamageManagerComponent dmgMgr=null, HitZone affectedHitZone=null)
Protected Member Functions inherited from SCR_DamageArea
void	ReevaluateDamageEffect (ChimeraCharacter playerCharacter, IEntity compartmentEntity)
	if amphibious vehicles protect from the area damage, we need to update the effect when they get in and out of the vehicle.
bool	IsEffectApplied (notnull IEntity entity)
	Checks if this effect is already applied to the entity.
void	AddEffect (notnull IEntity entity)
	Attempts to add this effect to the entity.
HitZone	GetAffectedHitZone (notnull SCR_DamageManagerComponent dmgMgr, SCR_EHitZoneSelectionMode hitZoneSelectionMode)

Protected Attributes
float	m_fDotDamage
float	m_fEffectDuration
bool	m_bAddDurationOnExit
EDamageType	m_eDotDamageType
Protected Attributes inherited from SCR_DamageArea
bool	m_bRegisterAutomatically
EDamageType	m_eDamageType
float	m_fDamageValue
ref BaseDamageEffect	m_DamageEffect
bool	m_bRemoveEffectWhenLeavingTheArea
bool	m_bPenetrateWatertightCompartments
SCR_EHitZoneSelectionMode	m_eHitZoneSelectionMode
ref SCR_BaseHitZoneSelector	m_CustomHitZoneSelector

Member Function Documentation

GetDamageEffect()

override BaseDamageEffect SCR_DotDamageArea.GetDamageEffect ( SCR_DamageManagerComponent dmgMgr = null, HitZone affectedHitZone = null )

protected

Parameters

[in]	dmgMgr	damage manager of the entity which is going to receive this damage effect
[in]	affectedHitZone	hit zone to which this damage effect should be applied

Returns

Damage effect which is applied by this area

Implements SCR_DamageArea.

OnAreaExit()

override void SCR_DotDamageArea.OnAreaExit

(

IEntity

entity

)

Callback when an entity exits this DamageArea this frame.

Parameters

[in]

entity

Implements SCR_DamageArea.

RemoveEffect()

override void SCR_DotDamageArea.RemoveEffect

(

notnull IEntity

entity

)

Attempts to find and remove this effect from the entity.

Parameters

[in]

entity

Implements SCR_DamageArea.

Member Data Documentation

m_bAddDurationOnExit

bool SCR_DotDamageArea.m_bAddDurationOnExit

protected

m_eDotDamageType

EDamageType SCR_DotDamageArea.m_eDotDamageType

protected

m_fDotDamage

float SCR_DotDamageArea.m_fDotDamage

protected

m_fEffectDuration

float SCR_DotDamageArea.m_fEffectDuration

protected

---

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

• Game/Damage/DamageAreas/SCR_DoTDamageArea.c