SCR_WheelHitZone Interface Reference

Inheritance diagram for SCR_WheelHitZone:

Public Member Functions
override void	OnInit (IEntity pOwnerEntity, GenericComponent pManagerComponent)
	Call OnInit method from script.
override EHitZoneGroup	GetHitZoneGroup ()
	Hit zone group getter to be overridden.
override void	OnDamageStateChanged (EDamageState newState, EDamageState previousDamageState, bool isJIP)
	Kill occupants and start destruction.
int	GetWheelIndex ()
void	SetWheelIndex (int index)
void	UpdateWheelState ()
	Set wheel parameters when damage exceeds thresholds.
override void	PlayDestructionSound (EDamageState damageState)
	Start destruction sounds.
void	WakeUpPhysics ()
	Wake physics up.
float	GetEfficiency ()
override EHitZoneGroup	GetHitZoneGroup ()
	Hit zone group getter to be overridden.
Public Member Functions inherited from SCR_DestructibleHitzone
ref SCR_DestructionBaseHandler	GetDestructionHandler ()
override void	OnInit (IEntity pOwnerEntity, GenericComponent pManagerComponent)
	Call OnInit method from script.
float	GetSecondaryExplosionScale ()
	Get secondary explosion desired scale. It will determine the prefab retrieved from secondary explosion config.
PointInfo	GetSecondaryExplosionPoint ()
	Get secondary explosion desired scale. It will determine the prefab retrieved from secondary explosion config.
override void	OnDamageStateChanged (EDamageState newState, EDamageState previousDamageState, bool isJIP)
	Kill occupants and start destruction.
void	StartDestruction (bool immediate=false)
	Start destruction effects.
void	PlayDestructionParticle (EDamageState state)
	Start destruction particle.
Public Member Functions inherited from SCR_HitZone
EHitZoneGroup	GetHitZoneGroup ()
	Hit zone group getter to be overridden.
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	OnInit (IEntity pOwnerEntity, GenericComponent pManagerComponent)
	Call OnInit method from script.
void	OnDamage (notnull BaseDamageContext damageContext)
	Called when the damage has been dealt by the server, doesn't get called for DOT.
float	ComputeEffectiveDamage (notnull BaseDamageContext damageContext, bool isDOT)
	Calculates the amount of damage a hitzone will receive.

Protected Member Functions
void	UpdateDamageSignal ()
Protected Member Functions inherited from SCR_DestructibleHitzone
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.
override void	OnDamageStateChanged (EDamageState newState, EDamageState previousDamageState, bool isJIP)
	Called when the damage state changes.
Protected Member Functions inherited from HitZone
void	OnHealthSet ()
	Called when damage changes.
void	OnMaxHealthChanged ()
	Called when max damage changes.
void	OnDamageStateChanged (EDamageState newState, EDamageState previousDamageState, bool isJIP)
	Called when damage state changes.

Protected Attributes
int	m_iWheelId
float	m_fDamagedRadiusScale
float	m_fDamagedLongitudinalFrictionScale
float	m_fDamagedLateralFrictionScale
float	m_fDamagedRoughnessIncrease
float	m_fDamagedDrag
float	m_fDestroyedRadiusScale
float	m_fDestroyedLongitudinalFrictionScale
float	m_fDestroyedLateralFrictionScale
float	m_fDestroyedRoughnessIncrease
float	m_fDestroyedDrag
Protected Attributes inherited from SCR_VehicleHitZone
EVehicleHitZoneGroup	m_eHitZoneGroup
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
Protected Attributes inherited from SCR_HitZone
ref array< ref SCR_DamagePassRule >	m_aDamagePassRules
float	m_fFireMultiplier
ref ScriptInvokerVoid	m_OnHealthChanged
ref ScriptInvoker	m_OnDamageStateChanged

Member Function Documentation

GetEfficiency()

float SCR_WheelHitZone.GetEfficiency

(

)

Returns

GetHitZoneGroup()

override EHitZoneGroup SCR_WheelHitZone.GetHitZoneGroup

(

)

Hit zone group getter to be overridden.

Returns

Hit zone group

Implements SCR_VehicleHitZone.

GetWheelIndex()

int SCR_WheelHitZone.GetWheelIndex

(

)

Returns

OnDamageStateChanged()

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

Kill occupants and start destruction.

Implements SCR_DestructibleHitzone.

OnInit()

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

Call OnInit method from script.

Implements SCR_DestructibleHitzone.

PlayDestructionSound()

override void SCR_WheelHitZone.PlayDestructionSound

(

EDamageState

damageState

)

Start destruction sounds.

Implements SCR_DestructibleHitzone.

SetWheelIndex()

void SCR_WheelHitZone.SetWheelIndex

(

int

index

)

Parameters

index

UpdateDamageSignal()

void SCR_WheelHitZone.UpdateDamageSignal ( )

protected

UpdateWheelState()

void SCR_WheelHitZone.UpdateWheelState

(

)

Set wheel parameters when damage exceeds thresholds.

WakeUpPhysics()

void SCR_WheelHitZone.WakeUpPhysics

(

)

Wake physics up.

Member Data Documentation

m_fDamagedDrag

float SCR_WheelHitZone.m_fDamagedDrag

protected

m_fDamagedLateralFrictionScale

float SCR_WheelHitZone.m_fDamagedLateralFrictionScale

protected

m_fDamagedLongitudinalFrictionScale

float SCR_WheelHitZone.m_fDamagedLongitudinalFrictionScale

protected

m_fDamagedRadiusScale

float SCR_WheelHitZone.m_fDamagedRadiusScale

protected

m_fDamagedRoughnessIncrease

float SCR_WheelHitZone.m_fDamagedRoughnessIncrease

protected

m_fDestroyedDrag

float SCR_WheelHitZone.m_fDestroyedDrag

protected

m_fDestroyedLateralFrictionScale

float SCR_WheelHitZone.m_fDestroyedLateralFrictionScale

protected

m_fDestroyedLongitudinalFrictionScale

float SCR_WheelHitZone.m_fDestroyedLongitudinalFrictionScale

protected

m_fDestroyedRadiusScale

float SCR_WheelHitZone.m_fDestroyedRadiusScale

protected

m_fDestroyedRoughnessIncrease

float SCR_WheelHitZone.m_fDestroyedRoughnessIncrease

protected

m_iWheelId

int SCR_WheelHitZone.m_iWheelId

protected

---

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

• Game/HitZone/SCR_WheelHitZone.c