SCR_DamageArea Interface Reference

Inheritance diagram for SCR_DamageArea:

Public Member Functions
bool	IsRegisteredAutomatically ()
override void	OnAreaEntered (notnull IEntity entity)
	Callback when an entity enters this DamageArea this frame.
override void	OnAreaExit (IEntity entity)
	Callback when an entity exits 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
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.
void	RemoveEffect (notnull IEntity entity)
	Attempts to find and remove this effect from the entity.
BaseDamageEffect	GetDamageEffect (SCR_DamageManagerComponent dmgMgr=null, HitZone affectedHitZone=null)
HitZone	GetAffectedHitZone (notnull SCR_DamageManagerComponent dmgMgr, SCR_EHitZoneSelectionMode hitZoneSelectionMode)

Protected Attributes
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

AddEffect()

void SCR_DamageArea.AddEffect ( notnull IEntity entity )

protected

Attempts to add this effect to the entity.

Parameters

[in]

entity

DisplayInfo()

override void SCR_DamageArea.DisplayInfo

(

)

Implements DamageArea.

GetAffectedHitZone()

HitZone SCR_DamageArea.GetAffectedHitZone ( notnull SCR_DamageManagerComponent dmgMgr, SCR_EHitZoneSelectionMode hitZoneSelectionMode )

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

GetDamageEffect()

BaseDamageEffect SCR_DamageArea.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

Implemented in SCR_DotDamageArea.

IsEffectApplied()

bool SCR_DamageArea.IsEffectApplied ( notnull IEntity entity )

protected

Checks if this effect is already applied to the entity.

Parameters

[in]

entity

IsRegisteredAutomatically()

bool SCR_DamageArea.IsRegisteredAutomatically

(

)

Returns

OnAreaEntered()

override void SCR_DamageArea.OnAreaEntered

(

notnull IEntity

entity

)

Callback when an entity enters this DamageArea this frame.

Parameters

[in]

entity

Implements DamageArea.

OnAreaExit()

override void SCR_DamageArea.OnAreaExit

(

IEntity

entity

)

Callback when an entity exits this DamageArea this frame.

Parameters

[in]

entity

Implements DamageArea.

Implemented in SCR_DotDamageArea.

ReevaluateDamageEffect()

void SCR_DamageArea.ReevaluateDamageEffect ( ChimeraCharacter playerCharacter, IEntity compartmentEntity )

protected

if amphibious vehicles protect from the area damage, we need to update the effect when they get in and out of the vehicle.

Parameters

[in]	playerCharacter
[in]	compartmentEntity

RemoveEffect()

void SCR_DamageArea.RemoveEffect ( notnull IEntity entity )

protected

Attempts to find and remove this effect from the entity.

Parameters

[in]

entity

Implemented in SCR_DotDamageArea.

Member Data Documentation

m_bPenetrateWatertightCompartments

bool SCR_DamageArea.m_bPenetrateWatertightCompartments

protected

m_bRegisterAutomatically

bool SCR_DamageArea.m_bRegisterAutomatically

protected

m_bRemoveEffectWhenLeavingTheArea

bool SCR_DamageArea.m_bRemoveEffectWhenLeavingTheArea

protected

m_CustomHitZoneSelector

ref SCR_BaseHitZoneSelector SCR_DamageArea.m_CustomHitZoneSelector

protected

m_DamageEffect

ref BaseDamageEffect SCR_DamageArea.m_DamageEffect

protected

m_eDamageType

EDamageType SCR_DamageArea.m_eDamageType

protected

m_eHitZoneSelectionMode

SCR_EHitZoneSelectionMode SCR_DamageArea.m_eHitZoneSelectionMode

protected

m_fDamageValue

float SCR_DamageArea.m_fDamageValue

protected

---

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

• Game/Damage/DamageAreas/SCR_DamageArea.c