PersistentDamageEffect Interface Reference

Inheritance diagram for PersistentDamageEffect:

Public Member Functions
proto external void	Terminate ()
	Terminates this DamageEffect.
proto external void	SetActive (bool value)
	When active, the damage effect will be updated on frame.
proto external bool	IsActive ()
	Checks if this effect is active or not.
void	EOnFrame (float timeSlice, SCR_ExtendedDamageManagerComponent dmgManager)
Public Member Functions inherited from SCR_DamageEffect
override bool	Save (ScriptBitWriter w)
	Since DamageEffects can't have rpl methods, streaming has to be done through this method.
override bool	Load (ScriptBitReader r)
	Since DamageEffects can't have rpl methods, streaming has to be done through this method.
EDamageType	GetDefaultDamageType ()
Public Member Functions inherited from BaseDamageEffect
proto external void	ApplyEffect (SCR_ExtendedDamageManagerComponent dmgManager)
	Called to apply a DamageEffect.
proto external float	GetTotalDamage ()
	Get total damage dealt until this point by this damage effect.
proto external EDamageType	GetDamageType ()
	Gettor for the DamageType of this DamageEffect.
proto external notnull Instigator	GetInstigator ()
	Gettor for the Instigator of this DamageEffect.
proto external HitZone	GetAffectedHitZone ()
	Gettor for which hitzone this DamageEffect was applied to.
proto external void	SetDamageType (EDamageType type)
	Settor for the DamageType of this DamageEffect.
proto external void	SetInstigator (notnull Instigator instigator)
	Settor for the instigator of the damage effect.
proto external void	SetAffectedHitZone (HitZone hitZone)
	Settor for the affected HitZone of the damage effect.
proto external bool	IsProxy ()
	Used to check if you are a proxy or not.
bool	HijackDamageEffect (SCR_ExtendedDamageManagerComponent dmgManager)
	Called before the damage effect is added to the damage manager If it returns true, damage effect is hijacked/intercepted and therefore not added/applied to the damage manager Any modifications done to the damage effect will persist.
void	OnEffectAdded (SCR_ExtendedDamageManagerComponent dmgManager)
	Called when this DamageEffect gets added to a DamageManager.
void	OnEffectApplied (SCR_ExtendedDamageManagerComponent dmgManager)
	Called when this DamageEffect gets applied on a DamageManager.
void	HandleConsequences (SCR_ExtendedDamageManagerComponent dmgManager, DamageEffectEvaluator evaluator)
	Called from ApplyEffect.
void	OnEffectRemoved (SCR_ExtendedDamageManagerComponent dmgManager)
	Called when this DamageEffect gets removed from a DamageManager.
void	OnDiag (SCR_ExtendedDamageManagerComponent dmgManager)
	When DamageEffect info is enabled on the diag menu, this will be called.
bool	Save (ScriptBitWriter w)
	Since DamageEffects can't have rpl methods, streaming has to be done through this method.
bool	Load (ScriptBitReader r)
	Since DamageEffects can't have rpl methods, streaming has to be done through this method.

Additional Inherited Members
Protected Member Functions inherited from SCR_DamageEffect
override void	HandleConsequences (SCR_ExtendedDamageManagerComponent dmgManager, DamageEffectEvaluator evaluator)
	Called from ApplyEffect.
override void	OnDiag (SCR_ExtendedDamageManagerComponent dmgManager)
	When DamageEffect info is enabled on the diag menu, this will be called.

Member Function Documentation

EOnFrame()

void PersistentDamageEffect.EOnFrame	(	float	timeSlice,
		SCR_ExtendedDamageManagerComponent	dmgManager
	)

Implemented in SCR_DotDamageEffect, SCR_BleedingDamageEffect, SCR_MorphineDamageEffect, SCR_PassiveHitZoneRegenDamageEffect, SCR_PhysicalHitZonesRegenDamageEffect, and SCR_SalineDamageEffect.

IsActive()

proto external bool PersistentDamageEffect.IsActive

(

)

Checks if this effect is active or not.

Returns

Returns true if the DamageEffect is being updated on frame.

SetActive()

proto external void PersistentDamageEffect.SetActive

(

bool

value

)

When active, the damage effect will be updated on frame.

Parameters

bool	value: When true, EOnFrame will get called when this damage effect is contained on a damage manager.

Terminate()

proto external void PersistentDamageEffect.Terminate

(

)

Terminates this DamageEffect.

It will be removed from the list of persistent effects on it´s containing damage manager. Only works on server.

---

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

• Game/generated/DamageEffects/PersistentDamageEffect.c