Inheritance diagram for BaseDamageEffect:

Public Member Functions
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 (notnull HitZone hitZone)
	Settor for the affected HitZone of the damage effect.

proto external bool	IsValueChangeAllowed ()
	Once this effect gets added to a manager, some of its values shouldn't change, as their change doesn't get replicated (instigator, damage type, affected hitzone) and it can lead to desync.

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.

Member Function Documentation

◆ ApplyEffect()

proto external void BaseDamageEffect.ApplyEffect ( SCR_ExtendedDamageManagerComponent dmgManager )

Called to apply a DamageEffect.

InstantDamageEffects get applied whenever they are added. PersistentDamageEffects only get applied when ApplyEffect() gets called. This call gets automatically replicated to clients, which means that BaseDamageEffect.Save will be getting called.

Parameters

SCR_ExtendedDamageManagerComponent dmgManager: Manager containing this DamageEffect

◆ GetAffectedHitZone()

proto external HitZone BaseDamageEffect.GetAffectedHitZone ( )

Gettor for which hitzone this DamageEffect was applied to.

Returns: Returns the HitZone where this DamageEffect got applied

◆ GetDamageType()

proto external EDamageType BaseDamageEffect.GetDamageType ( )

Gettor for the DamageType of this DamageEffect.

Returns: Returns type of the damage dealt by this DamageEffect

◆ GetInstigator()

proto external notnull Instigator BaseDamageEffect.GetInstigator ( )

Gettor for the Instigator of this DamageEffect.

Returns: Instigator of this DamageEffect

◆ GetTotalDamage()

proto external float BaseDamageEffect.GetTotalDamage ( )

Get total damage dealt until this point by this damage effect.

Returns: total damage applied by this damage effect

◆ HandleConsequences()

void BaseDamageEffect.HandleConsequences	(	SCR_ExtendedDamageManagerComponent	dmgManager,
		DamageEffectEvaluator	evaluator )

Called from ApplyEffect.

Consequences of handling a damage effect should be implemented on the evaluator when possible, as it makes effects more flexible.

Parameters

SCR_ExtendedDamageManagerComponent	dmgManager: Manager containing this DamageEffect
DamageEffectEvaluator	evaluator: Evaluator being used by the damage manager.

Implemented in SCR_AnimatedFallDamageEffect, SCR_BackBlastDamageEffect, SCR_BandageDamageEffect, SCR_BarbedWireCuttingDamageEffect, SCR_BaseBlastDamageEffect, SCR_BaseBulletDamageEffect, SCR_BlastForceDamageEffect, SCR_BleedingDamageEffect, SCR_CollisionDamageEffect, SCR_ConcussionDamageEffect, SCR_DamageEffect, SCR_DotDamageEffect, SCR_DrowningDamageEffect, SCR_ExplosionDamageEffect, SCR_FallDamageEffect, SCR_FragmentationDamageEffect, SCR_IncendiaryBulletDamageEffect, SCR_IncendiaryDamageEffect, SCR_InstantDamageEffect, SCR_MeleeDamageEffect, SCR_MorphineDamageEffect, SCR_MuzzleBlastDamageEffect, SCR_PassiveHitZoneRegenDamageEffect, SCR_PersistentBarbedWireDamageEffect, SCR_PersistentDamageEffect, SCR_PhysicalHitZonesRegenDamageEffect, SCR_RagdollFallDamageEffect, SCR_SalineDamageEffect, SCR_SpecialCollisionDamageEffect, SCR_TourniquetDamageEffect, and SCR_VehicleFireDamageEffect.

◆ HijackDamageEffect()

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

Parameters

SCR_ExtendedDamageManagerComponent dmgManager: Manager containing this DamageEffect

Implemented in SCR_BleedingDamageEffect, SCR_MorphineDamageEffect, SCR_PhysicalHitZonesRegenDamageEffect, and SCR_SalineDamageEffect.

◆ IsProxy()

proto external bool BaseDamageEffect.IsProxy ( )

Used to check if you are a proxy or not.

Returns: true if this DamageEffect is a proxy

◆ IsValueChangeAllowed()

proto external bool BaseDamageEffect.IsValueChangeAllowed ( )

Once this effect gets added to a manager, some of its values shouldn't change, as their change doesn't get replicated (instigator, damage type, affected hitzone) and it can lead to desync.

Returns: true if the effect hasnt been added to a manager yet (and therefore its values can still change)

◆ Load()

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

Implemented in SCR_BleedingDamageEffect, SCR_DamageEffect, SCR_DotDamageEffect, and SCR_SpecialCollisionDamageEffect.

◆ OnDiag()

void BaseDamageEffect.OnDiag ( SCR_ExtendedDamageManagerComponent dmgManager )

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

Implemented in SCR_BleedingDamageEffect, SCR_DamageEffect, SCR_DotDamageEffect, and SCR_PersistentDamageEffect.

◆ OnEffectAdded()

void BaseDamageEffect.OnEffectAdded ( SCR_ExtendedDamageManagerComponent dmgManager )

Called when this DamageEffect gets added to a DamageManager.

Parameters

SCR_ExtendedDamageManagerComponent dmgManager: Manager containing this DamageEffect

Implemented in SCR_BandageDamageEffect, SCR_BleedingDamageEffect, SCR_MorphineDamageEffect, SCR_PassiveHitZoneRegenDamageEffect, SCR_PersistentBarbedWireDamageEffect, SCR_PhysicalHitZonesRegenDamageEffect, SCR_SpecialCollisionDamageEffect, and SCR_TourniquetDamageEffect.

◆ OnEffectApplied()

void BaseDamageEffect.OnEffectApplied ( SCR_ExtendedDamageManagerComponent dmgManager )

Called when this DamageEffect gets applied on a DamageManager.

Parameters

SCR_ExtendedDamageManagerComponent dmgManager: Manager containing this DamageEffect

Implemented in SCR_SpecialCollisionDamageEffect.

◆ OnEffectRemoved()

void BaseDamageEffect.OnEffectRemoved ( SCR_ExtendedDamageManagerComponent dmgManager )

Called when this DamageEffect gets removed from a DamageManager.

Parameters

SCR_ExtendedDamageManagerComponent dmgManager: Manager containing this DamageEffect

Implemented in SCR_BleedingDamageEffect, and SCR_SpecialCollisionDamageEffect.

◆ Save()

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

Implemented in SCR_BleedingDamageEffect, SCR_DamageEffect, SCR_DotDamageEffect, and SCR_SpecialCollisionDamageEffect.

◆ SetAffectedHitZone()

proto external void BaseDamageEffect.SetAffectedHitZone ( notnull HitZone hitZone )

Settor for the affected HitZone of the damage effect.

Parameters

HitZone hitZone: new HitZone for this DamageEffect

◆ SetDamageType()

proto external void BaseDamageEffect.SetDamageType ( EDamageType type )

Settor for the DamageType of this DamageEffect.

Parameters

EDamageType type: new damage type

◆ SetInstigator()

proto external void BaseDamageEffect.SetInstigator ( notnull Instigator instigator )

Settor for the instigator of the damage effect.

Parameters

Instigator instigator: new Instigator of the effect

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

Game/generated/DamageEffects/BaseDamageEffect.c

Public Member Functions

Member Function Documentation

◆ ApplyEffect()

◆ GetAffectedHitZone()

◆ GetDamageType()

◆ GetInstigator()

◆ GetTotalDamage()

◆ HandleConsequences()

◆ HijackDamageEffect()

◆ IsProxy()

◆ IsValueChangeAllowed()

◆ Load()

◆ OnDiag()

◆ OnEffectAdded()

◆ OnEffectApplied()

◆ OnEffectRemoved()

◆ Save()

◆ SetAffectedHitZone()

◆ SetDamageType()

◆ SetInstigator()