Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
SCR_RotorDamageManagerComponent Interface Reference
Inheritance diagram for SCR_RotorDamageManagerComponent:
[legend]

Public Member Functions

override bool ShouldCountAsHit (notnull BaseDamageContext damageContext)
 Calculate whether bullets actually hit the rotor with RotorHitChance.
 
void PlayRotorImpactSound (vector contactPos, int contactShapeIndex1)
 
override void OnDamageStateChanged (EDamageState state)
 Invoked when damage state changes.
 
override bool FilterContact (IEntity owner, IEntity other, Contact contact)
 Contacts aren't handled without hitzones on rotorDamageManager.
 
override void OnFilteredContact (IEntity owner, IEntity other, Contact contact)
 Only called if FilterContact returned true.
 
override void OnInit (IEntity owner)
 Called during EOnInit.
 
- Public Member Functions inherited from SCR_DamageManagerComponent
bool IsRplReady ()
 Check if replication loading is completed. Important for join in progress and when streaming entities in.
 
HitZone GetHitZoneByName (string hitZoneName, bool caseSensitive=false)
 Get the HitZone that matches the provided name.
 
void GetPhysicalHitZones (out notnull array< HitZone > physicalHitZones)
 Return hit zones with colliders assigned.
 
void GetRegeneratingHitZones (out notnull array< SCR_RegeneratingHitZone > regeneratingHitZones)
 Return hit zones with passive regeneration enabled.
 
void RpcDo_SetFireState (int hitZoneIndex, SCR_EBurningState fireState)
 Set fire rate of a flammable hitzone.
 
override bool FilterContact (IEntity owner, IEntity other, Contact contact)
 No contacts for destroyed entities.
 
float CalculateMomentum (Contact contact, float ownerMass, float otherMass)
 
int GetSurroundingHitzones (vector origin, Physics physics, float maxDistance, out array< HitZone > outHitzones)
 
float GetMinDestroyDamage (EDamageType damageType, array< HitZone > hitzones, int count)
 
ScriptInvoker GetOnDamage ()
 
ScriptInvoker GetOnDamageOverTimeAdded ()
 
ScriptInvoker GetOnDamageOverTimeRemoved ()
 
ScriptInvoker GetOnDamageStateChanged ()
 
void ~SCR_DamageManagerComponent ()
 
int GetHitZonesOfGroup (EHitZoneGroup hitZoneGroup, out notnull array< HitZone > groupHitZones, bool clearArray=true)
 Get a list of all hitzones of specific hitzone group.
 
int GetHitZonesOfGroups (notnull array< EHitZoneGroup > hitZoneGroups, out notnull array< HitZone > groupHitZones)
 Get a list of all hitzones of specific hitzone group.
 
float GetGroupDamageOverTime (ECharacterHitZoneGroup hitZoneGroup, EDamageType damageType)
 Get total damage over time of given hitzone group.
 
void Kill (notnull Instigator instigator)
 Neutralize the entity with a specific damage type, registering the killer entity.
 
void DamageRandomHitZones (float damage, EDamageType type, notnull Instigator instigator, bool onlyPhysical=true, vector outMat[3]={}, bool damageDefault=false)
 Damage random physical hit zones up to damage amount.
 
bool CanBeHealed (bool ignoreHealingDOT=true)
 Return true if there is damage that can be repaired.
 
void FullHeal (bool ignoreHealingDOT=true)
 Fix all the damage.
 
float HealHitZones (float healthToDistribute, bool sequential=false, float maxHealThresholdScaled=1, array< HitZone > alternativeHitZones=null)
 Partially heal the hitZones of an entity.
 
void ReduceSmoke ()
 Reduce smoke output based on the total health of hit zones.
 
float GetHitZonesDamage (float untilThresholdScaled=1, array< HitZone > alternativeHitZones=null)
 Get all damage dealt to hitzones.
 
float GetHitZonesHealthScaled (array< HitZone > alternativeHitZones=null)
 Get Health scaled of all hitzones.
 
float GetSingleHitZonesHealthScaled (array< HitZone > alternativeHitZones=null, bool getLowestHealth=true)
 Get single Health scaled from hitzones.
 
ResourceName GetSecondaryExplosion (float value, SCR_ESecondaryExplosionType explosionType, EResourceType resourceType=EResourceType.SUPPLIES, bool fire=false)
 Determine secondary explosion prefab based on explosion value, type and resource type if defined.
 
SCR_SecondaryExplosion GetSecondaryExplosionForScale (SCR_ESecondaryExplosionScale scale, SCR_ESecondaryExplosionType explosionType, EResourceType resourceType=EResourceType.SUPPLIES)
 Determine secondary explosion prefab based on explosion scale, type and resource type if defined.
 
SCR_ESecondaryExplosionScale GetSecondaryExplosionScale (float value, SCR_ESecondaryExplosionType explosionType, EResourceType resourceType=EResourceType.SUPPLIES)
 Determine secondary explosion prefab based on explosion value, type and resource type if defined.
 
ResourceName GetSecondaryFireParticle (float value, SCR_ESecondaryExplosionType explosionType, EResourceType resourceType=EResourceType.SUPPLIES)
 Determine secondary explosion prefab based on explosion value, type and resource type if defined.
 
bool IsOnFire (HitZone hitZone=null)
 Determine if provided or any hit zone from this damage manager is on fire.
 
bool IsOnFire (notnull array< HitZone > hitZones)
 Determine if any hit zone from this damage manager is on fire.
 
void SecondaryExplosion (ResourceName prefabName, notnull Instigator instigator, notnull EntitySpawnParams spawnParams)
 Spawn secondary explosion.
 
SCR_ResourceEncapsulator GetResourceEncapsulator (EResourceType suppliesType=EResourceType.SUPPLIES)
 
void SupplySecondaryExplosion (notnull Instigator instigator)
 Spawn supply secondary explosion when vehicle becomes destroyed.
 
vector GetSecondaryExplosionPosition (TypeName hitZoneType, out float totalWeight=0)
 Get weighed average position of explosion for hitzones of specified type.
 
void FuelSecondaryExplosion (notnull Instigator instigator)
 Spawn fuel secondary explosion when vehicle becomes destroyed.
 
void UpdateFireDamage (float timeSlice)
 
void UpdateFireParticles (vector position, out ParticleEffectEntity particles, SCR_ESecondaryExplosionScale state, SCR_ESecondaryExplosionType fireType, EResourceType resourceType=EResourceType.SUPPLIES)
 Update visual effects and store result in particles variable.
 
override void OnDamageOverTimeAdded (EDamageType dType, float dps, HitZone hz)
 Invoked every time the DoT is added to certain hitzone.
 
override void OnDamageOverTimeRemoved (EDamageType dType, HitZone hz)
 Invoked when provided damage type is removed from certain hitzone.
 
override bool HijackDamageHandling (notnull BaseDamageContext damageContext)
 
- Public Member Functions inherited from DamageManagerComponent
proto external int ComputeStruckHitZones (out notnull array< HitZone > struckHitZones, notnull BaseDamageContext damageContext)
 Clears and fills struckHitZones array with all HZs that should get damaged by this BaseDamageContext.
 
proto external void EnableDamageHandling (bool enable)
 
proto external bool IsDamageHandlingEnabled ()
 
proto external float GetMovementDamage ()
 
proto external float GetAimingDamage ()
 
proto external void SetMovementDamage (float damage)
 
proto external void SetAimingDamage (float damage)
 
proto external float GetHealthScaled ()
 
proto external bool SetHealthScaled (float health)
 
proto external float GetHealth ()
 
proto external float GetMaxHealth ()
 
proto external EDamageState GetState ()
 
proto external bool IsDestroyed ()
 
proto external void SetInstigatorEntity (IEntity instigator)
 
proto external void SetInstigator (notnull Instigator instigator)
 
proto external notnull Instigator GetInstigator ()
 
proto external int GetAttachedColliderIDs (out notnull array< int > outAttachedColliderIDs)
 Fills colliderIDs with all the colliders attached to hitzones this dmg manager owns.
 
proto external void HandleDamage (notnull BaseDamageContext damageContext)
 
proto external bool IsDamagedOverTime (EDamageType dType)
 
proto external float GetDamageOverTime (EDamageType dType)
 
proto external void RemoveDamageOverTime (EDamageType dType)
 Removes DOT of provided damageType from all currently affected HitZones.
 
bool ShouldOverrideInstigator (notnull Instigator currentInstigator, notnull Instigator newInstigator)
 Called whenever an instigator is going to be set.
 
GameMaterial OverrideHitMaterial (HitZone struckHitzone)
 Not all armors are physical so the surface that gets struck by projectiles will not be the one the armor, but the hitzone.
 
bool FilterContact (IEntity owner, IEntity other, Contact contact)
 Event when physics engine registered contact with other RigidBody.
 
bool HijackDamageHandling (notnull BaseDamageContext damageContext)
 Called when this DamageManager is about to handle damage.
 
bool ShouldCountAsHit (notnull BaseDamageContext damageContext)
 Called after HijackDamageHandling.
 
- Public Member Functions inherited from HitZoneContainerComponent
proto external IEntity GetOwner ()
 
proto external HitZone GetDefaultHitZone ()
 
proto external HitZone GetHitZoneByColliderID (int colliderID)
 
proto external int GetHitZonesByColliderIDs (out notnull array< HitZone > outHitZones, notnull array< int > colliderIDs)
 Clears and fills the specified outHitZones array with all HZs that are attached to colliderIDs.
 
proto external HitZone GetHitZone (string colliderName)
 
proto external int GetAllHitZones (out notnull array< HitZone > outHitZones)
 Clears and fills the specified outHitZones array with all HZs in this entity Returns the count of elements that were filled into the array.
 
proto external int GetAllHitZonesInHierarchy (out notnull array< HitZone > outHitZones)
 Clears and fills the specified outHitZones array with all HZs in this entity and its children.
 
proto external HitZoneContainerComponent GetParentHitZoneContainer ()
 
- Public Member Functions inherited from GameComponent
bool OnTicksOnRemoteProxy ()
 

Protected Member Functions

void DamageRotors (float damage)
 
void DamageOther (notnull IEntity other, float damage)
 
void EmitRotorParticles (vector contactPos, GameMaterial contactMat)
 
bool TraceFilter (notnull IEntity e)
 
void RPC_OnContactBroadcast (vector contactPos, vector contactNormal, int contactShapeIndex1)
 Clients don't simulate physics so this rpc replicates collision information for particles, sound etc.
 
void GetComponentsDelayed ()
 
- Protected Member Functions inherited from SCR_DamageManagerComponent
override bool OnRplSave (ScriptBitWriter writer)
 
override bool OnRplLoad (ScriptBitReader reader)
 
notnull SCR_DamageManagerData GetScriptedDamageManagerData ()
 
override void OnDamage (notnull BaseDamageContext damageContext)
 
override bool ShouldOverrideInstigator (notnull Instigator currentInstigator, notnull Instigator newInstigator)
 Called whenever an instigator is going to be set.
 
float HealHitZonesInSequence (float healthToDistribute, float maxHealThresholdScaled, array< HitZone > targetHitZones)
 
float HealHitZonesInParallel (float healthToDistribute, float maxHealThresholdScaled, array< HitZone > targetHitZones)
 
void ConnectToFireDamageSystem ()
 
void DisconnectFromFireDamageSystem ()
 
override void OnDamageStateChanged (EDamageState state)
 Invoked when damage state changes.
 
override void _WB_AfterWorldUpdate (IEntity owner, float timeSlice)
 
- Protected Member Functions inherited from DamageManagerComponent
void OnDamageOverTimeAdded (EDamageType dType, float dps, HitZone hz)
 Invoked every time the DoT is added to certain hitzone.
 
void OnDamageOverTimeRemoved (EDamageType dType, HitZone hz)
 Invoked when provided damage type is removed from certain hitzone.
 
void OnDamageStateChanged (EDamageState state)
 Called when the damagestate changes.
 
void OnPostInit (IEntity owner)
 Called after all components are initialized.
 
void OnInit (IEntity owner)
 Called during EOnInit.
 
void OnDelete (IEntity owner)
 
void OnFrame (IEntity owner, float timeSlice)
 Called during EOnFrame.
 
void OnFilteredContact (IEntity owner, IEntity other, Contact contact)
 Only called if FilterContact returned true.
 
void OnDiag (IEntity owner, float timeSlice)
 Called during EOnDiag.
 
void OnDamage (notnull BaseDamageContext damageContext)
 
bool OnRplSave (ScriptBitWriter writer)
 
bool OnRplLoad (ScriptBitReader reader)
 

Protected Attributes

VehicleHelicopterSimulation m_HelicopterSimulation
 
SCR_VehicleDamageManagerComponent m_RootDamageManager
 
SoundComponent m_SoundComponent
 
SCR_RotorHitZone m_RotorHitZone
 
ParticleEffectEntity m_ParticleEffectEntity
 
ref ParticleEffectEntitySpawnParams m_ParticleSpawnParams
 
int m_iShapeIndex1 = -1
 
float m_fImpulseDamageMultiplier
 
float m_fRotorDamageMultiplier
 
float m_fCharacterDamageMultiplier
 
float m_fMinCharacterDamage
 
float m_fMaxCharacterDamage
 
ResourceName m_sDefaultParticlePath
 
int m_iEffectIndex
 
string m_sImpactSoundEvent
 
- Protected Attributes inherited from SCR_DamageManagerComponent
int m_iTimetickInstigator = System.GetTickCount()
 
int m_iTimeThresholdInstigatorReplacement = 180000
 
int m_iPlayerId = 0
 
int m_iDamageManagerDataIndex = -1
 
bool m_bRplReady
 

Static Protected Attributes

const float MIN_ROTOR_DAMAGE = 15.0
 
- Static Protected Attributes inherited from SCR_DamageManagerComponent
static const int MIN_MOMENTUM_RESPONSE_INDEX = 1
 
static const int MAX_MOMENTUM_RESPONSE_INDEX = 5
 
static const int MIN_DESTRUCTION_RESPONSE_INDEX = 6
 
const float SIMULATION_IMPRECISION_MULTIPLIER = 1.1
 
static ref array< ref SCR_DamageManagerDatas_aDamageManagerData = {}
 

Additional Inherited Members

- Static Public Member Functions inherited from SCR_DamageManagerComponent
static SCR_DamageManagerComponent GetDamageManager (notnull IEntity owner)
 Get damage manager from given owner.
 
- Static Public Attributes inherited from SCR_DamageManagerComponent
static const int MAX_DESTRUCTION_RESPONSE_INDEX = 10
 
static const string MAX_DESTRUCTION_RESPONSE_INDEX_NAME = "HugeDestructible"
 
static const ref array< EDamageTypeHEALING_DAMAGE_TYPES = {EDamageType.HEALING, EDamageType.REGENERATION}
 

Member Function Documentation

◆ DamageOther()

void SCR_RotorDamageManagerComponent.DamageOther ( notnull IEntity  other,
float  damage 
)
protected

◆ DamageRotors()

void SCR_RotorDamageManagerComponent.DamageRotors ( float  damage)
protected

◆ EmitRotorParticles()

void SCR_RotorDamageManagerComponent.EmitRotorParticles ( vector  contactPos,
GameMaterial  contactMat 
)
protected

◆ FilterContact()

override bool SCR_RotorDamageManagerComponent.FilterContact ( IEntity  owner,
IEntity  other,
Contact  contact 
)

Contacts aren't handled without hitzones on rotorDamageManager.

Implements SCR_DamageManagerComponent.

◆ GetComponentsDelayed()

void SCR_RotorDamageManagerComponent.GetComponentsDelayed ( )
protected

◆ OnDamageStateChanged()

override void SCR_RotorDamageManagerComponent.OnDamageStateChanged ( EDamageState  state)

Invoked when damage state changes.

Disable collision damage calculations for wrecks

Implements SCR_DamageManagerComponent.

◆ OnFilteredContact()

override void SCR_RotorDamageManagerComponent.OnFilteredContact ( IEntity  owner,
IEntity  other,
Contact  contact 
)

Only called if FilterContact returned true.

Parameters
ownerThe owner entity
otherOther Entity who contacted us
contactStructure describing the contact

Implements DamageManagerComponent.

◆ OnInit()

override void SCR_RotorDamageManagerComponent.OnInit ( IEntity  owner)

Called during EOnInit.

Parameters
ownerEntity this component is attached to.

Implements DamageManagerComponent.

◆ PlayRotorImpactSound()

void SCR_RotorDamageManagerComponent.PlayRotorImpactSound ( vector  contactPos,
int  contactShapeIndex1 
)
Parameters
[in]contactPos
[in]contactShapeIndex1

◆ RPC_OnContactBroadcast()

void SCR_RotorDamageManagerComponent.RPC_OnContactBroadcast ( vector  contactPos,
vector  contactNormal,
int  contactShapeIndex1 
)
protected

Clients don't simulate physics so this rpc replicates collision information for particles, sound etc.

◆ ShouldCountAsHit()

override bool SCR_RotorDamageManagerComponent.ShouldCountAsHit ( notnull BaseDamageContext  damageContext)

Calculate whether bullets actually hit the rotor with RotorHitChance.

Implements DamageManagerComponent.

◆ TraceFilter()

bool SCR_RotorDamageManagerComponent.TraceFilter ( notnull IEntity  e)
protected

Member Data Documentation

◆ m_fCharacterDamageMultiplier

float SCR_RotorDamageManagerComponent.m_fCharacterDamageMultiplier
protected

◆ m_fImpulseDamageMultiplier

float SCR_RotorDamageManagerComponent.m_fImpulseDamageMultiplier
protected

◆ m_fMaxCharacterDamage

float SCR_RotorDamageManagerComponent.m_fMaxCharacterDamage
protected

◆ m_fMinCharacterDamage

float SCR_RotorDamageManagerComponent.m_fMinCharacterDamage
protected

◆ m_fRotorDamageMultiplier

float SCR_RotorDamageManagerComponent.m_fRotorDamageMultiplier
protected

◆ m_HelicopterSimulation

VehicleHelicopterSimulation SCR_RotorDamageManagerComponent.m_HelicopterSimulation
protected

◆ m_iEffectIndex

int SCR_RotorDamageManagerComponent.m_iEffectIndex
protected

◆ m_iShapeIndex1

int SCR_RotorDamageManagerComponent.m_iShapeIndex1 = -1
protected

◆ m_ParticleEffectEntity

ParticleEffectEntity SCR_RotorDamageManagerComponent.m_ParticleEffectEntity
protected

◆ m_ParticleSpawnParams

ref ParticleEffectEntitySpawnParams SCR_RotorDamageManagerComponent.m_ParticleSpawnParams
protected

◆ m_RootDamageManager

SCR_VehicleDamageManagerComponent SCR_RotorDamageManagerComponent.m_RootDamageManager
protected

◆ m_RotorHitZone

SCR_RotorHitZone SCR_RotorDamageManagerComponent.m_RotorHitZone
protected

◆ m_sDefaultParticlePath

ResourceName SCR_RotorDamageManagerComponent.m_sDefaultParticlePath
protected

◆ m_sImpactSoundEvent

string SCR_RotorDamageManagerComponent.m_sImpactSoundEvent
protected

◆ m_SoundComponent

SoundComponent SCR_RotorDamageManagerComponent.m_SoundComponent
protected

◆ MIN_ROTOR_DAMAGE

const float SCR_RotorDamageManagerComponent.MIN_ROTOR_DAMAGE = 15.0
staticprotected

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