SCR_PoisonDamageEffect Interface Reference

Inheritance diagram for SCR_PoisonDamageEffect:

Public Member Functions
override 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.
override bool	UseBatchProcessing ()
	Method called locally by SCR_DamageSufferingSystem to determine if it should group all instances of this damage effect type for processing.
override void	BatchData (inout SCR_BatchedDamageEffects batchedDataContainer, notnull SCR_PersistentDamageEffect effect)
	Method called locally by SCR_DamageSufferingSystem to store any neccessary information about effect into a derivative of a SCR_BatchedDamageEffects for further processing.
override void	BatchProcessing (notnull SCR_ExtendedDamageManagerComponent dmgManager, notnull SCR_BatchedDamageEffects batchedDataContainer, bool isAuthority)
	Method called locally by SCR_DamageSufferingSystem to do a singular processing for this damage effect type.
override bool	ExecuteSynchronizedSoundPlayback (notnull SCR_ExtendedDamageManagerComponent dmgManager)
	Method meant to be called by replicated events to use local data for sound playback.
override void	OnEffectAdded (SCR_ExtendedDamageManagerComponent dmgManager)
	Called when this DamageEffect gets added to a DamageManager.
override void	OnEffectRemoved (SCR_ExtendedDamageManagerComponent dmgManager)
	Called when this DamageEffect gets removed from a DamageManager.
BaseInfoDisplay	GetScreenEffect (notnull SCR_ExtendedDamageManagerComponent dmgManager, TypeName effectType)
override float	GetCustomDamageValue ()
	Method called locally by SCR_DamageSufferingSystem to get relevant damage amount for this specific damage effect.
override void	RecalculateDPS (float timeSlice, notnull SCR_ExtendedDamageManagerComponent dmgManager)
	Method called locally by SCR_DamageSufferingSystem to allow local computation of the DPS.
override bool	SaveApplyEffect (ScriptBitWriter w)
	It is indented to work togeter with SCR_OnEffectApplied to send replicated data to clients.
override bool	LoadApplyEffect (ScriptBitReader r)
	It is indented to work togeter with SCR_OnEffectApplied to load replicated data to clients.
Public Member Functions inherited from SCR_DotDamageEffect
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.
void	SkipRegenDelay (bool skip)
	When this is toggled PRIOR to the damage effect being added, the regen will start instantly OnEffectAdded.
bool	GetSkipRegenDelay (SCR_ExtendedDamageManagerComponent dmgManager)
	Will return true if regen delay was enabled.
Public Member Functions inherited from DotDamageEffect
proto external void	DealDot (float timeSlice, SCR_ExtendedDamageManagerComponent dmgManager)
	Applies DOT equivalent to timeSlice seconds.
proto external void	DealCustomDot (notnull HitZone hitzone, float dotAmount, notnull DotDamageEffectTimerToken token, SCR_ExtendedDamageManagerComponent dmgManager)
proto external void	SetDPS (float dps)
	set amount of damage per second.
proto external void	SetMaxDuration (float newMaxduration)
	Set max duration for this DOT effect.
proto external void	ExtendMaxDuration (float amount)
	Increases the max duration of this damage effect.
proto external DotDamageEffectTimerToken	UpdateTimer (float timeSlice, SCR_ExtendedDamageManagerComponent dmgManager)
	Updates current duration of this damage effect by timeSlice and returns a token to be used for DealCustomDot.
proto external float	GetAccurateTimeSlice (float timeSlice)
	timeSlice can exceed the remaining time for DOT, this will return the accurate amount of DOT time left that can be applied.
proto external float	GetDPS ()
	Returns amount of Damage Per Second applied by this DamageEffect.
proto external float	GetCurrentDuration ()
	Returns amount of time this effect has been running.
proto external float	GetMaxDuration ()
Public Member Functions inherited from SCR_PersistentDamageEffect
void	IndividualProcessing (notnull SCR_ExtendedDamageManagerComponent dmgManager)
	Method called locally by SCR_DamageSufferingSystem when UseBatchProcessing() returns false.
Public Member Functions inherited from PersistentDamageEffect
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.
Public Member Functions inherited from SCR_DamageEffect
bool	IsProxy (SCR_ExtendedDamageManagerComponent dmgManager)
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 (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.
void	OnEffectApplied (SCR_ExtendedDamageManagerComponent dmgManager)
	Called when this DamageEffect gets applied on a DamageManager.

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

Protected Attributes
bool	m_bIsDecaying
float	m_fLocalDPSValue

Static Protected Attributes
static const int	SOUND_COOLDOWN = 1500
const int	CRITICAL_DMG_THRESHOLD = 4
const int	MAX_DMG_VALUE = 100

Member Function Documentation

BatchData()

override void SCR_PoisonDamageEffect.BatchData	(	inout SCR_BatchedDamageEffects	batchedDataContainer,
		notnull SCR_PersistentDamageEffect	effect )

Method called locally by SCR_DamageSufferingSystem to store any neccessary information about effect into a derivative of a SCR_BatchedDamageEffects for further processing.

Parameters

[in,out]	batchedDataContainer	to which batched information must be stored
[in]	effect	which is currently being batched

Implements SCR_PersistentDamageEffect.

BatchProcessing()

override void SCR_PoisonDamageEffect.BatchProcessing	(	notnull SCR_ExtendedDamageManagerComponent	dmgManager,
		notnull SCR_BatchedDamageEffects	batchedDataContainer,
		bool	isAuthority )

Method called locally by SCR_DamageSufferingSystem to do a singular processing for this damage effect type.

Parameters

[in]	dmgManager	for which this data is being processed
[in]	batchedDataContainer
[in]	isAuthority	- RplRole.Authority

Returns

true when processing was successful, otherwise false

Implements SCR_PersistentDamageEffect.

EOnFrame()

override void SCR_PoisonDamageEffect.EOnFrame ( float timeSlice, SCR_ExtendedDamageManagerComponent dmgManager )

protected

Implements SCR_DotDamageEffect.

ExecuteSynchronizedSoundPlayback()

override bool SCR_PoisonDamageEffect.ExecuteSynchronizedSoundPlayback

(

notnull SCR_ExtendedDamageManagerComponent

dmgManager

)

Method meant to be called by replicated events to use local data for sound playback.

Parameters

[in]

dmgManager

Returns

true sound playback should be considered as successful

Implements SCR_PersistentDamageEffect.

GetCustomDamageValue()

override float SCR_PoisonDamageEffect.GetCustomDamageValue

(

)

Method called locally by SCR_DamageSufferingSystem to get relevant damage amount for this specific damage effect.

Returns

Implements SCR_DotDamageEffect.

GetScreenEffect()

BaseInfoDisplay SCR_PoisonDamageEffect.GetScreenEffect	(	notnull SCR_ExtendedDamageManagerComponent	dmgManager,
		TypeName	effectType )

Parameters

[in]	dmgManager
[in]	effectType

Returns

HandleConsequences()

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

protected

Called from ApplyEffect.

Implements SCR_DotDamageEffect.

HijackDamageEffect()

override bool SCR_PoisonDamageEffect.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

Implements BaseDamageEffect.

LoadApplyEffect()

override bool SCR_PoisonDamageEffect.LoadApplyEffect

(

ScriptBitReader

r

)

It is indented to work togeter with SCR_OnEffectApplied to load replicated data to clients.

Implements PersistentDamageEffect.

OnEffectAdded()

override void SCR_PoisonDamageEffect.OnEffectAdded

(

SCR_ExtendedDamageManagerComponent

dmgManager

)

Called when this DamageEffect gets added to a DamageManager.

Parameters

SCR_ExtendedDamageManagerComponent

dmgManager: Manager containing this DamageEffect

Implements BaseDamageEffect.

OnEffectRemoved()

override void SCR_PoisonDamageEffect.OnEffectRemoved

(

SCR_ExtendedDamageManagerComponent

dmgManager

)

Called when this DamageEffect gets removed from a DamageManager.

Parameters

SCR_ExtendedDamageManagerComponent

dmgManager: Manager containing this DamageEffect

Implements BaseDamageEffect.

RecalculateDPS()

override void SCR_PoisonDamageEffect.RecalculateDPS	(	float	timeSlice,
		notnull SCR_ExtendedDamageManagerComponent	dmgManager )

Method called locally by SCR_DamageSufferingSystem to allow local computation of the DPS.

Parameters

[in]	timeSlice
[in]	dmgManager

Implements SCR_DotDamageEffect.

SaveApplyEffect()

override bool SCR_PoisonDamageEffect.SaveApplyEffect

(

ScriptBitWriter

w

)

It is indented to work togeter with SCR_OnEffectApplied to send replicated data to clients.

Implements PersistentDamageEffect.

UseBatchProcessing()

override bool SCR_PoisonDamageEffect.UseBatchProcessing

(

)

Method called locally by SCR_DamageSufferingSystem to determine if it should group all instances of this damage effect type for processing.

Returns

true if batch processing should be used, otherwise false

Implements SCR_PersistentDamageEffect.

Member Data Documentation

CRITICAL_DMG_THRESHOLD

const int SCR_PoisonDamageEffect.CRITICAL_DMG_THRESHOLD = 4

staticprotected

m_bIsDecaying

bool SCR_PoisonDamageEffect.m_bIsDecaying

protected

m_fLocalDPSValue

float SCR_PoisonDamageEffect.m_fLocalDPSValue

protected

MAX_DMG_VALUE

const int SCR_PoisonDamageEffect.MAX_DMG_VALUE = 100

staticprotected

SOUND_COOLDOWN

const int SCR_PoisonDamageEffect.SOUND_COOLDOWN = 1500

staticprotected

---

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

• Game/Damage/DamageEffects/CharacterDamageEffects/SCR_PoisonDamageEffect.c