Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_PersistentBarbedWireDamageEffect Interface Reference
Inheritance diagram for SCR_PersistentBarbedWireDamageEffect:
SCR_SpecialCollisionDamageEffect SCR_PersistentDamageEffect PersistentDamageEffect SCR_DamageEffect BaseDamageEffect

Public Member Functions

override void OnEffectAdded (SCR_ExtendedDamageManagerComponent dmgManager)
 Called when this DamageEffect gets added to a DamageManager.
 
override EDamageType GetDefaultDamageType ()
 
SCR_BarbedWireCuttingDamageEffect GetResultingEffect ()
 
- Public Member Functions inherited from SCR_SpecialCollisionDamageEffect
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.
 
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)
 
- 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 EOnFrame (float timeSlice, SCR_ExtendedDamageManagerComponent dmgManager)
 
- Protected Member Functions inherited from SCR_SpecialCollisionDamageEffect
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

float m_fMaxDamageSpeed
 
ref Curve m_cSpeedDamageCurve
 
ref SCR_BarbedWireCuttingDamageEffect m_ResultingEffect
 
- Protected Attributes inherited from SCR_SpecialCollisionDamageEffect
SCR_CharacterControllerComponent m_Controller
 
IEntity m_ResponsibleEntity
 
float m_fSpecialCollisionMaxSpeedLimitScaled
 
bool m_bSpecialCollisionAllowJumpingClimbing
 
string m_sOnDamageSoundEvent
 
int m_iDamageSoundEvent = 0
 

Static Protected Attributes

static const float DAMAGE_APPLY_THRESHOLD = 2
 

Member Function Documentation

◆ EOnFrame()

override void SCR_PersistentBarbedWireDamageEffect.EOnFrame ( float timeSlice,
SCR_ExtendedDamageManagerComponent dmgManager )
protected

◆ GetDefaultDamageType()

override EDamageType SCR_PersistentBarbedWireDamageEffect.GetDefaultDamageType ( )

Implements SCR_DamageEffect.

◆ GetResultingEffect()

SCR_BarbedWireCuttingDamageEffect SCR_PersistentBarbedWireDamageEffect.GetResultingEffect ( )

◆ HandleConsequences()

override void SCR_PersistentBarbedWireDamageEffect.HandleConsequences ( SCR_ExtendedDamageManagerComponent dmgManager,
DamageEffectEvaluator evaluator )
protected

Called from ApplyEffect.

Implements SCR_SpecialCollisionDamageEffect.

◆ OnEffectAdded()

override void SCR_PersistentBarbedWireDamageEffect.OnEffectAdded ( SCR_ExtendedDamageManagerComponent dmgManager)

Called when this DamageEffect gets added to a DamageManager.

Parameters
SCR_ExtendedDamageManagerComponentdmgManager: Manager containing this DamageEffect

Implements SCR_SpecialCollisionDamageEffect.

Member Data Documentation

◆ DAMAGE_APPLY_THRESHOLD

const float SCR_PersistentBarbedWireDamageEffect.DAMAGE_APPLY_THRESHOLD = 2
staticprotected

◆ m_cSpeedDamageCurve

ref Curve SCR_PersistentBarbedWireDamageEffect.m_cSpeedDamageCurve
protected

◆ m_fMaxDamageSpeed

float SCR_PersistentBarbedWireDamageEffect.m_fMaxDamageSpeed
protected

◆ m_ResultingEffect

ref SCR_BarbedWireCuttingDamageEffect SCR_PersistentBarbedWireDamageEffect.m_ResultingEffect
protected

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