SCR_DamageEffect Interface Reference

Inheritance diagram for SCR_DamageEffect:

Public Member Functions
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.

Protected Member Functions
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

GetDefaultDamageType()

EDamageType SCR_DamageEffect.GetDefaultDamageType

(

)

Implemented in SCR_BleedingDamageEffect, SCR_MorphineDamageEffect, and SCR_SalineDamageEffect.

HandleConsequences()

override void SCR_DamageEffect.HandleConsequences ( SCR_ExtendedDamageManagerComponent  dmgManager, DamageEffectEvaluator  evaluator  )

protected

Called from ApplyEffect.

Implements BaseDamageEffect.

Implemented in SCR_DotDamageEffect, SCR_InstantDamageEffect, SCR_PersistentDamageEffect, SCR_BandageDamageEffect, SCR_BleedingDamageEffect, SCR_DrowningDamageEffect, SCR_MorphineDamageEffect, SCR_PassiveHitZoneRegenDamageEffect, SCR_PhysicalHitZonesRegenDamageEffect, SCR_SalineDamageEffect, SCR_TourniquetDamageEffect, SCR_BaseBulletDamageEffect, SCR_BlastForceDamageEffect, SCR_CollisionDamageEffect, SCR_ExplosionDamageEffect, SCR_FragmentationDamageEffect, SCR_IncendiaryBulletDamageEffect, SCR_IncendiaryDamageEffect, and SCR_MeleeDamageEffect.

Load()

override bool SCR_DamageEffect.Load

(

ScriptBitReader

r

)

Since DamageEffects can't have rpl methods, streaming has to be done through this method.

This method writes the necessary info for the replication of this DamageEffect and sends it through the network

Parameters

ScriptBitReader

r: Streamed data should be read from here.

Returns

true if there were no issues on replication

Implements BaseDamageEffect.

Implemented in SCR_DotDamageEffect, and SCR_BleedingDamageEffect.

OnDiag()

override void SCR_DamageEffect.OnDiag ( SCR_ExtendedDamageManagerComponent  dmgManager )

protected

When DamageEffect info is enabled on the diag menu, this will be called.

Used to write debug information about this DamageEffect

Parameters

SCR_ExtendedDamageManagerComponent

dmgManager: Manager containing this DamageEffect

Implements BaseDamageEffect.

Implemented in SCR_DotDamageEffect, SCR_PersistentDamageEffect, and SCR_BleedingDamageEffect.

Save()

override bool SCR_DamageEffect.Save

(

ScriptBitWriter

w

)

Since DamageEffects can't have rpl methods, streaming has to be done through this method.

This method writes the necessary info for the replication of this DamageEffect and sends it through the network

Parameters

ScriptBitWriter

w: data to stream should be written here.

Returns

true if there were no issues on replication

Implements BaseDamageEffect.

Implemented in SCR_DotDamageEffect, and SCR_BleedingDamageEffect.

---

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

• Game/Damage/DamageEffects/BaseDamageEffects/SCR_DamageEffect.c