Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_FuelHitZone Interface Reference
Inheritance diagram for SCR_FuelHitZone:
SCR_DestructibleHitzone SCR_HitZone HitZone

Public Member Functions

override EHitZoneGroup GetHitZoneGroup ()
 Hit zone group getter to be overridden.
 
override void OnInit (IEntity pOwnerEntity, GenericComponent pManagerComponent)
 Call OnInit method from script.
 
void UpdateFuelTankState ()
 
SCR_FuelNode GetFuelTank ()
 
int GetFuelTankID ()
 
void SetFuelNodeID (int fuelNodeID)
 Assign hitzone to a simulation fuel tank.
 
override void OnDamageStateChanged (EDamageState newState, EDamageState previousDamageState, bool isJIP)
 Kill occupants and start destruction.
 
override float GetSecondaryExplosionScale ()
 Get secondary explosion desired scale. It will determine the prefab retrieved from secondary explosion config.
 
- Public Member Functions inherited from SCR_DestructibleHitzone
ref SCR_DestructionBaseHandler GetDestructionHandler ()
 
PointInfo GetSecondaryExplosionPoint ()
 Get secondary explosion desired scale. It will determine the prefab retrieved from secondary explosion config.
 
void StartDestruction (bool immediate=false)
 Start destruction effects.
 
void PlayDestructionParticle (EDamageState state)
 Start destruction particle.
 
- Public Member Functions inherited from SCR_HitZone
ScriptInvokerVoid GetOnHealthChanged (bool createNew=true)
 Get event called when hitzone damage changes.
 
ScriptInvoker GetOnDamageStateChanged (bool createNew=true)
 Get event called when hitzone damage state changes.
 
IEntity GetOwner ()
 
override float ComputeEffectiveDamage (notnull BaseDamageContext damageContext, bool isDOT)
 Calculates the amount of damage a hitzone will receive.
 
void DrawDebug ()
 
void ApplyDamagePassRules (notnull BaseDamageContext damageContext)
 
void HandlePassedDamage (notnull BaseDamageContext damageContext)
 
- Public Member Functions inherited from HitZone
proto external float GetBaseDamageMultiplier ()
 
proto external bool HasColliderNodes ()
 
proto external int GetColliderDescriptorIndex (int colliderID)
 
proto external float GetDamageMultiplier (EDamageType dmgType)
 
proto external float GetDamageReduction ()
 
proto external float GetDamageThreshold ()
 
proto external int GetAllColliderNames (out notnull array< string > colliderNames)
 
proto external void SetDamageOverTime (EDamageType dmgType, float dps)
 Sets damage over time for this particular hitzone.
 
proto external float GetDamageOverTime (EDamageType dmgType)
 
proto external int GetNumColliderDescriptors ()
 
proto external HitZoneContainerComponent GetHitZoneContainer ()
 
proto external void SetHealth (float health)
 
proto external void SetHealthScaled (float health)
 
proto external void SetMaxHealth (float maxHealth, ESetMaxHealthFlags flag=ESetMaxHealthFlags.NONE)
 
proto external float GetHealth ()
 
proto external float GetHealthScaled ()
 
proto external float GetDamageStateThreshold (EDamageState damageState)
 
proto external float GetMaxHealth ()
 
proto external string GetName ()
 
proto external EDamageState GetDamageState ()
 
proto external float GetCriticalDamageThreshold ()
 
proto external EDamageState GetPreviousDamageState ()
 
proto external void HandleDamage (float damage, int damageType, IEntity instigator)
 
proto external bool IsProxy ()
 
proto external int GetColliderIDs (out notnull array< int > outIDs)
 Returns all collider IDs attached to this hitzone.
 
proto bool TryGetColliderDescription (IEntity owner, int descIndex, out vector transformLS[4], out int boneIndex, out int nodeID)
 
proto bool TryGetColliderDescriptionFromName (IEntity owner, string colliderName, out vector transformLS[4], out int boneIndex, out int nodeID)
 
void OnDamage (notnull BaseDamageContext damageContext)
 Called when the damage has been dealt by the server, doesn't get called for DOT.
 

Protected Attributes

int m_iFuelTankID
 
EVehicleHitZoneGroup m_eHitZoneGroup
 
float m_fMinExplosionScaleFactor
 
SCR_FuelNode m_FuelTank
 
- Protected Attributes inherited from SCR_DestructibleHitzone
ref PointInfo m_SecondaryExplosionPoint
 
ref SCR_DestructionBaseHandler m_pDestructionHandler
 
string m_sDestructionSoundEvent
 
ResourceName m_sDestructionParticle
 
vector m_vParticleOffset
 
ParticleEffectEntity m_DstParticle
 
SCR_DamageManagerComponent m_ParentDamageManager
 
SCR_DamageManagerComponent m_RootDamageManager
 
SCR_BaseCompartmentManagerComponent m_CompartmentManager
 
ref array< ChimeraCharacterm_aEjectedCharacters
 
- Protected Attributes inherited from SCR_HitZone
ref array< ref SCR_DamagePassRulem_aDamagePassRules
 
float m_fFireMultiplier
 
ref ScriptInvokerVoid m_OnHealthChanged
 
ref ScriptInvoker m_OnDamageStateChanged
 

Additional Inherited Members

- Protected Member Functions inherited from SCR_DestructibleHitzone
void OnCharacterEjectedFromDestroyedCompartment (ChimeraCharacter playerCharacter, IEntity compartmentEntity)
 Callback that will be triggered when character will be removed from the destroyed vehicle.
 
void ForceStartDestruction ()
 Force begining of the destruction process.
 
void StopDestruction ()
 Stop destruction effects.
 
SCR_VehicleDamageManagerComponent FindParentVehicleDamageManager ()
 
void PlayDestructionSound (EDamageState damageState)
 Start destruction sounds.
 
- Protected Member Functions inherited from SCR_HitZone
override void OnHealthSet ()
 Called when damage changes.
 
- Protected Member Functions inherited from HitZone
void OnMaxHealthChanged ()
 Called when max damage changes.
 
- Static Protected Attributes inherited from SCR_DestructibleHitzone
const int FORCED_DESTRUCTION_DELAY = 1000
 Time after which we will no longer wait for players to leave destroyed vehicle and force start the destruction.
 

Member Function Documentation

◆ GetFuelTank()

SCR_FuelNode SCR_FuelHitZone.GetFuelTank ( )

◆ GetFuelTankID()

int SCR_FuelHitZone.GetFuelTankID ( )

◆ GetHitZoneGroup()

override EHitZoneGroup SCR_FuelHitZone.GetHitZoneGroup ( )

Hit zone group getter to be overridden.

Returns
Hit zone group

Implements SCR_HitZone.

◆ GetSecondaryExplosionScale()

override float SCR_FuelHitZone.GetSecondaryExplosionScale ( )

Get secondary explosion desired scale. It will determine the prefab retrieved from secondary explosion config.

Implements SCR_DestructibleHitzone.

◆ OnDamageStateChanged()

override void SCR_FuelHitZone.OnDamageStateChanged ( EDamageState newState,
EDamageState previousDamageState,
bool isJIP )

Kill occupants and start destruction.

Implements SCR_DestructibleHitzone.

◆ OnInit()

override void SCR_FuelHitZone.OnInit ( IEntity pOwnerEntity,
GenericComponent pManagerComponent )

Call OnInit method from script.

Implements SCR_DestructibleHitzone.

◆ SetFuelNodeID()

void SCR_FuelHitZone.SetFuelNodeID ( int fuelNodeID)

Assign hitzone to a simulation fuel tank.

◆ UpdateFuelTankState()

void SCR_FuelHitZone.UpdateFuelTankState ( )

Member Data Documentation

◆ m_eHitZoneGroup

EVehicleHitZoneGroup SCR_FuelHitZone.m_eHitZoneGroup
protected

◆ m_fMinExplosionScaleFactor

float SCR_FuelHitZone.m_fMinExplosionScaleFactor
protected

◆ m_FuelTank

SCR_FuelNode SCR_FuelHitZone.m_FuelTank
protected

◆ m_iFuelTankID

int SCR_FuelHitZone.m_iFuelTankID
protected

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