Inheritance diagram for SCR_SpecialCollisionDamageEffect:

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

void	SetResponsibleEntity (notnull IEntity entity)

IEntity	GetResponsibleEntity ()

void	ApplyMobilityLimits (SCR_ExtendedDamageManagerComponent dmgManager)

float	GetMaxSpeedLimitScaled ()

bool	GetJumpingAndClimbingAllowed ()

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.

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.

void	EOnFrame (float timeSlice, SCR_ExtendedDamageManagerComponent dmgManager)

bool	SaveApplyEffect (ScriptBitWriter w)
	It is indented to work togeter with SCR_OnEffectApplied to send replicated data to clients.

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_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.

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.

Protected Member Functions
override void	HandleConsequences (SCR_ExtendedDamageManagerComponent dmgManager, DamageEffectEvaluator evaluator)
	Called from ApplyEffect.

override void	OnEffectApplied (SCR_ExtendedDamageManagerComponent dmgManager)
	Called when this DamageEffect gets applied on a DamageManager.

Protected Member Functions inherited from SCR_PersistentDamageEffect
override void	OnDiag (SCR_ExtendedDamageManagerComponent dmgManager)
	When DamageEffect info is enabled on the diag menu, this will be called.

Protected Attributes
SCR_CharacterControllerComponent	m_Controller

IEntity	m_ResponsibleEntity

float	m_fSpecialCollisionMaxSpeedLimitScaled

bool	m_bSpecialCollisionAllowJumpingClimbing

string	m_sOnDamageSoundEvent

int	m_iDamageSoundEvent = 0

Member Function Documentation

◆ ApplyMobilityLimits()

void SCR_SpecialCollisionDamageEffect.ApplyMobilityLimits ( SCR_ExtendedDamageManagerComponent dmgManager )

◆ GetJumpingAndClimbingAllowed()

bool SCR_SpecialCollisionDamageEffect.GetJumpingAndClimbingAllowed ( )

◆ GetMaxSpeedLimitScaled()

float SCR_SpecialCollisionDamageEffect.GetMaxSpeedLimitScaled ( )

◆ GetResponsibleEntity()

IEntity SCR_SpecialCollisionDamageEffect.GetResponsibleEntity ( )

◆ HandleConsequences()

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

protected

Called from ApplyEffect.

Implements SCR_PersistentDamageEffect.

Implemented in SCR_PersistentBarbedWireDamageEffect.

◆ Load()

override bool SCR_SpecialCollisionDamageEffect.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 SCR_DamageEffect.

◆ OnEffectAdded()

override void SCR_SpecialCollisionDamageEffect.OnEffectAdded ( SCR_ExtendedDamageManagerComponent dmgManager )

Called when this DamageEffect gets added to a DamageManager.

Parameters

SCR_ExtendedDamageManagerComponent dmgManager: Manager containing this DamageEffect

Implements BaseDamageEffect.

Implemented in SCR_PersistentBarbedWireDamageEffect.

◆ OnEffectApplied()

override void SCR_SpecialCollisionDamageEffect.OnEffectApplied ( SCR_ExtendedDamageManagerComponent dmgManager )

protected

Called when this DamageEffect gets applied on a DamageManager.

Parameters

SCR_ExtendedDamageManagerComponent dmgManager: Manager containing this DamageEffect

Implements BaseDamageEffect.

◆ OnEffectRemoved()

override void SCR_SpecialCollisionDamageEffect.OnEffectRemoved ( SCR_ExtendedDamageManagerComponent dmgManager )

Called when this DamageEffect gets removed from a DamageManager.

Parameters

SCR_ExtendedDamageManagerComponent dmgManager: Manager containing this DamageEffect

Implements BaseDamageEffect.

◆ Save()

override bool SCR_SpecialCollisionDamageEffect.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 SCR_DamageEffect.

◆ SetResponsibleEntity()

void SCR_SpecialCollisionDamageEffect.SetResponsibleEntity ( notnull IEntity entity )

Member Data Documentation

◆ m_bSpecialCollisionAllowJumpingClimbing

bool SCR_SpecialCollisionDamageEffect.m_bSpecialCollisionAllowJumpingClimbing

protected

◆ m_Controller

SCR_CharacterControllerComponent SCR_SpecialCollisionDamageEffect.m_Controller

protected

◆ m_fSpecialCollisionMaxSpeedLimitScaled

float SCR_SpecialCollisionDamageEffect.m_fSpecialCollisionMaxSpeedLimitScaled

protected

◆ m_iDamageSoundEvent

int SCR_SpecialCollisionDamageEffect.m_iDamageSoundEvent = 0

protected

◆ m_ResponsibleEntity

IEntity SCR_SpecialCollisionDamageEffect.m_ResponsibleEntity

protected

◆ m_sOnDamageSoundEvent

string SCR_SpecialCollisionDamageEffect.m_sOnDamageSoundEvent

protected

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

Game/Damage/DamageEffects/DamageEffectSources/SCR_SpecialCollisionDamageEffect.c

Public Member Functions

Protected Member Functions

Protected Attributes

Member Function Documentation

◆ ApplyMobilityLimits()

◆ GetJumpingAndClimbingAllowed()

◆ GetMaxSpeedLimitScaled()

◆ GetResponsibleEntity()

◆ HandleConsequences()

◆ Load()

◆ OnEffectAdded()

◆ OnEffectApplied()

◆ OnEffectRemoved()

◆ Save()

◆ SetResponsibleEntity()

Member Data Documentation

◆ m_bSpecialCollisionAllowJumpingClimbing

◆ m_Controller

◆ m_fSpecialCollisionMaxSpeedLimitScaled

◆ m_iDamageSoundEvent

◆ m_ResponsibleEntity

◆ m_sOnDamageSoundEvent