SCR_DestructibleEntity Interface Reference

Inheritance diagram for SCR_DestructibleEntity:

Public Member Functions
float	GetDamageMultiplier (EDamageType type)
float	GetDamageReduction ()
float	GetDamageThreshold ()
float	GetMaxHealth ()
void	RegenerateNavmeshDelayed ()
override void	OnDamage (int previousState, int newState, EDamageType type, float damageTaken, float currentHealth, inout vector hitTransform[3], ScriptBitWriter frameData)
void	SetModel (ResourceName model)
	Sets the model of the object.
float	GetDestructibleSize ()
void	PlaySound (int damagePhaseIndex)
override void	OnStateChanged (int destructibleState, ScriptBitReader frameData, bool JIP)
override void	OnBeforeDestroyed ()
float	CalculateMomentum (Contact contact, float ownerMass, float otherMass)
void	UpdateResponseIndex (float currentHealth)
bool	IsProxy ()
override void	EOnContact (IEntity owner, IEntity other, Contact contact)
	Contact.
void	SCR_DestructibleEntity (IEntitySource src, IEntity parent)
Public Member Functions inherited from DestructibleEntity
proto external void	HandleDamage (EDamageType type, float damage, out vector hitPosDirNorm[3])
proto external int	GetCorrespondingState (float hp)
proto external float	GetCurrentHealth ()
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.

Static Public Attributes
const float	SIMULATION_IMPRECISION_MULTIPLIER = 1.1
static const int	MAX_DESTRUCTION_RESPONSE_INDEX = 10
static const string	MAX_DESTRUCTION_RESPONSE_INDEX_NAME = "HugeDestructible"
static const int	TOTAL_DESTRUCTION_MAX_HEALTH_MULTIPLIER = 10

Protected Member Functions
void	SpawnPhaseObjects (SCR_BaseDestructionPhase phase, SCR_DestructionData destructionData)
	Spawns objects that are meant to be created when the object is destroyed (particles, debris, etc)
void	GoToDamagePhase (int damagePhaseIndex, int previousDamagePhaseIndex, SCR_DestructionData destructionData, bool streamed)
	Only call from OnStateChanged, otherwise you have HUGE desync.
void	SetDamagePhaseSignal (int damagePhaseIndex=0)
Protected Member Functions inherited from DestructibleEntity
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)

Static Protected Attributes
static const int	MIN_MOMENTUM_RESPONSE_INDEX = 1
static const int	MAX_MOMENTUM_RESPONSE_INDEX = 5
static const int	MIN_DESTRUCTION_RESPONSE_INDEX = 6
static const string	DAMAGE_PHASE_SIGNAL_NAME = "DamagePhase"

Constructor & Destructor Documentation

SCR_DestructibleEntity()

void SCR_DestructibleEntity.SCR_DestructibleEntity	(	IEntitySource	src,
		IEntity	parent
	)

Member Function Documentation

CalculateMomentum()

float SCR_DestructibleEntity.CalculateMomentum	(	Contact	contact,
		float	ownerMass,
		float	otherMass
	)

EOnContact()

override void SCR_DestructibleEntity.EOnContact	(	IEntity	owner,
		IEntity	other,
		Contact	contact
	)

Contact.

GetDamageMultiplier()

float SCR_DestructibleEntity.GetDamageMultiplier

(

EDamageType

type

)

GetDamageReduction()

float SCR_DestructibleEntity.GetDamageReduction

(

)

GetDamageThreshold()

float SCR_DestructibleEntity.GetDamageThreshold

(

)

GetDestructibleSize()

float SCR_DestructibleEntity.GetDestructibleSize

(

)

GetMaxHealth()

float SCR_DestructibleEntity.GetMaxHealth

(

)

GoToDamagePhase()

void SCR_DestructibleEntity.GoToDamagePhase ( int  damagePhaseIndex, int  previousDamagePhaseIndex, SCR_DestructionData  destructionData, bool  streamed  )

protected

Only call from OnStateChanged, otherwise you have HUGE desync.

IsProxy()

bool SCR_DestructibleEntity.IsProxy

(

)

OnBeforeDestroyed()

override void SCR_DestructibleEntity.OnBeforeDestroyed

(

)

Implements DestructibleEntity.

OnDamage()

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

Implements DestructibleEntity.

OnStateChanged()

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

Implements DestructibleEntity.

PlaySound()

void SCR_DestructibleEntity.PlaySound

(

int

damagePhaseIndex

)

RegenerateNavmeshDelayed()

void SCR_DestructibleEntity.RegenerateNavmeshDelayed

(

)

SetDamagePhaseSignal()

void SCR_DestructibleEntity.SetDamagePhaseSignal ( int  damagePhaseIndex = 0 )

protected

SetModel()

void SCR_DestructibleEntity.SetModel

(

ResourceName

model

)

Sets the model of the object.

SpawnPhaseObjects()

void SCR_DestructibleEntity.SpawnPhaseObjects ( SCR_BaseDestructionPhase  phase, SCR_DestructionData  destructionData  )

protected

Spawns objects that are meant to be created when the object is destroyed (particles, debris, etc)

UpdateResponseIndex()

void SCR_DestructibleEntity.UpdateResponseIndex

(

float

currentHealth

)

Member Data Documentation

DAMAGE_PHASE_SIGNAL_NAME

const string SCR_DestructibleEntity.DAMAGE_PHASE_SIGNAL_NAME = "DamagePhase"

staticprotected

MAX_DESTRUCTION_RESPONSE_INDEX

const int SCR_DestructibleEntity.MAX_DESTRUCTION_RESPONSE_INDEX = 10

static

MAX_DESTRUCTION_RESPONSE_INDEX_NAME

const string SCR_DestructibleEntity.MAX_DESTRUCTION_RESPONSE_INDEX_NAME = "HugeDestructible"

static

MAX_MOMENTUM_RESPONSE_INDEX

const int SCR_DestructibleEntity.MAX_MOMENTUM_RESPONSE_INDEX = 5

staticprotected

MIN_DESTRUCTION_RESPONSE_INDEX

const int SCR_DestructibleEntity.MIN_DESTRUCTION_RESPONSE_INDEX = 6

staticprotected

MIN_MOMENTUM_RESPONSE_INDEX

const int SCR_DestructibleEntity.MIN_MOMENTUM_RESPONSE_INDEX = 1

staticprotected

SIMULATION_IMPRECISION_MULTIPLIER

const float SCR_DestructibleEntity.SIMULATION_IMPRECISION_MULTIPLIER = 1.1

static

TOTAL_DESTRUCTION_MAX_HEALTH_MULTIPLIER

const int SCR_DestructibleEntity.TOTAL_DESTRUCTION_MAX_HEALTH_MULTIPLIER = 10

static

---

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

• Game/Destruction/SCR_DestructibleEntity.c