DestructibleEntity Interface Reference

Inheritance diagram for DestructibleEntity:

Public Member Functions
proto external void	HandleDamage (EDamageType type, float damage, out vector hitPosDirNorm[3])
proto external int	GetCorrespondingState (float hp)
proto external float	GetCurrentHealth ()
int	GetDestructionCategory ()
int	GetDestructionWeight ()
float	ComputeEffectiveDamage (EDamageType damageType, float rawDamage, IEntity damageSource, notnull Instigator instigator, const GameMaterial hitMaterial, inout vector hitTransform[3], const vector impactVelocity)
	Calculates the amount of damage a hitzone will receive.

Protected Member Functions
void	OnDamage (int previousState, int newState, EDamageType type, float damageTaken, float currentHealth, inout vector hitTransform[3], ScriptBitWriter frameData)
void	OnStateChanged (int destructibleState, ScriptBitReader frameData, bool JIP)
void	OnBeforeDestroyed ()
bool	OnContact (IEntity owner, IEntity other, Contact contact)

Member Function Documentation

ComputeEffectiveDamage()

float DestructibleEntity.ComputeEffectiveDamage	(	EDamageType	damageType,
		float	rawDamage,
		IEntity	damageSource,
		notnull Instigator	instigator,
		const GameMaterial	hitMaterial,
		inout vector	hitTransform[3],
		const vector	impactVelocity )

Calculates the amount of damage a hitzone will receive.

Parameters

damageType	Damage type
rawDamage	Incoming damage, without any modifiers taken into account
damageSource	Projectile
Instigator	instigator
hitMaterial	Hit surface physics material
hitTransform	Hit position, direction and normal
impactVelocity	Projectile velocity at the time of impact

GetCorrespondingState()

proto external int DestructibleEntity.GetCorrespondingState

(

float

hp

)

GetCurrentHealth()

proto external float DestructibleEntity.GetCurrentHealth

(

)

GetDestructionCategory()

int DestructibleEntity.GetDestructionCategory

(

)

GetDestructionWeight()

int DestructibleEntity.GetDestructionWeight

(

)

HandleDamage()

proto external void DestructibleEntity.HandleDamage	(	EDamageType	type,
		float	damage,
		out vector	hitPosDirNorm[3] )

OnBeforeDestroyed()

void DestructibleEntity.OnBeforeDestroyed ( )

protected

Implemented in SCR_DestructibleEntity.

OnContact()

bool DestructibleEntity.OnContact ( IEntity owner, IEntity other, Contact contact )

protected

OnDamage()

void DestructibleEntity.OnDamage ( int previousState, int newState, EDamageType type, float damageTaken, float currentHealth, inout vector hitTransform[3], ScriptBitWriter frameData )

protected

Implemented in SCR_DestructibleEntity.

OnStateChanged()

void DestructibleEntity.OnStateChanged ( int destructibleState, ScriptBitReader frameData, bool JIP )

protected

Implemented in SCR_DestructibleEntity.

---

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

• Game/generated/Entities/DestructibleEntity.c