Arma Reforger Script API
|
Public Member Functions | |
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. | |
![]() | |
bool | IsProxy (SCR_ExtendedDamageManagerComponent dmgManager) |
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 () |
![]() | |
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 | OnEffectRemoved (SCR_ExtendedDamageManagerComponent dmgManager) |
Called when this DamageEffect gets removed from a DamageManager. | |
Additional Inherited Members | |
![]() | |
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. | |
void PersistentDamageEffect.EOnFrame | ( | float | timeSlice, |
SCR_ExtendedDamageManagerComponent | dmgManager ) |
proto external bool PersistentDamageEffect.IsActive | ( | ) |
Checks if this effect is active or not.
bool PersistentDamageEffect.LoadApplyEffect | ( | ScriptBitReader | r | ) |
It is indented to work togeter with SCR_OnEffectApplied to load replicated data to clients.
bool PersistentDamageEffect.SaveApplyEffect | ( | ScriptBitWriter | w | ) |
It is indented to work togeter with SCR_OnEffectApplied to send replicated data to clients.
proto external void PersistentDamageEffect.SetActive | ( | bool | value | ) |
When active, the damage effect will be updated on frame.
bool | value: When true, EOnFrame will get called when this damage effect is contained on a damage manager. |
proto external void PersistentDamageEffect.Terminate | ( | ) |
Terminates this DamageEffect.
It will be removed from the list of persistent effects on it�s containing damage manager. Only works on server.