Arma Reforger Script API
Loading...
Searching...
No Matches
HitZoneContainerComponent Interface Reference
Inheritance diagram for HitZoneContainerComponent:
GameComponent DamageManagerComponent SCR_DamageManagerComponent ExtendedDamageManagerComponent SCR_ArmorDamageManagerComponent SCR_DestructibleBuildingComponent SCR_DestructionDamageManagerComponent SCR_MineDamageManager SCR_RotorDamageManagerComponent SCR_VehicleDamageManagerComponent SCR_ExtendedDamageManagerComponent SCR_DestructionFractalComponent SCR_DestructionMultiPhaseComponent SCR_HelicopterDamageManagerComponent SCR_WheeledDamageManagerComponent SCR_CharacterDamageManagerComponent SCR_DestructionTireComponent

Public Member Functions

proto external IEntity GetOwner ()
 
proto external HitZone GetDefaultHitZone ()
 
proto external HitZone GetHitZoneByName (string hitZoneName)
 Get the HitZone that matches the provided collider name.
 
proto external HitZone GetHitZoneByColliderID (int colliderID)
 Get the HitZone that matches the provided collider ID.
 
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 CountAllHitZones ()
 Counts the number of hitzones in this entity.
 
proto external int CountAllHitZonesInHierarchy ()
 Counts the number of hitzones in this entity and its children.
 
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

bool HasDataToReplicate ()
 Use it to save bandwidth in some default conditions. Use it if Save and Load are overriden.
 
bool OnRplSave (ScriptBitWriter writer)
 
bool OnRplLoad (ScriptBitReader reader)
 

Member Function Documentation

◆ CountAllHitZones()

proto external int HitZoneContainerComponent.CountAllHitZones ( )

Counts the number of hitzones in this entity.

Use instead of GetAllHitZones when you only need to get the count because this function does not allocate memory.

◆ CountAllHitZonesInHierarchy()

proto external int HitZoneContainerComponent.CountAllHitZonesInHierarchy ( )

Counts the number of hitzones in this entity and its children.

Use instead of GetAllHitZonesInHierachy when you only need to get the count because this function does not allocate memory.

◆ GetAllHitZones()

proto external int HitZoneContainerComponent.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.

◆ GetAllHitZonesInHierarchy()

proto external int HitZoneContainerComponent.GetAllHitZonesInHierarchy ( out notnull array< HitZone > outHitZones)

Clears and fills the specified outHitZones array with all HZs in this entity and its children.

Returns the count of elements that were filled into the array.

◆ GetDefaultHitZone()

proto external HitZone HitZoneContainerComponent.GetDefaultHitZone ( )

◆ GetHitZone()

proto external HitZone HitZoneContainerComponent.GetHitZone ( string colliderName)

◆ GetHitZoneByColliderID()

proto external HitZone HitZoneContainerComponent.GetHitZoneByColliderID ( int colliderID)

Get the HitZone that matches the provided collider ID.

Only searches on the component. Returns the hitzone matching the collider ID, or null if the hitzone can't be found.

◆ GetHitZoneByName()

proto external HitZone HitZoneContainerComponent.GetHitZoneByName ( string hitZoneName)

Get the HitZone that matches the provided collider name.

Searches the entire hierarchy. Returns the hitzone matching the provided name, or null if the hitzone can't be found.

◆ GetHitZonesByColliderIDs()

proto external int HitZoneContainerComponent.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.

Returns the hitzones matching those collider IDs Returns the count of elements that were filled into the array.

◆ GetOwner()

proto external IEntity HitZoneContainerComponent.GetOwner ( )

◆ GetParentHitZoneContainer()

proto external HitZoneContainerComponent HitZoneContainerComponent.GetParentHitZoneContainer ( )

◆ HasDataToReplicate()

bool HitZoneContainerComponent.HasDataToReplicate ( )
protected

Use it to save bandwidth in some default conditions. Use it if Save and Load are overriden.

Implemented in SCR_DestructibleBuildingComponent.

◆ OnRplLoad()

bool HitZoneContainerComponent.OnRplLoad ( ScriptBitReader reader)
protected

◆ OnRplSave()

bool HitZoneContainerComponent.OnRplSave ( ScriptBitWriter writer)
protected

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