SCR_DestructionBaseHandler Interface Reference

Base destruction handler, destruction handler types extend from this TODO: Move this to damage manager instead Ported from SCR_DestructionDamageManagerComponent. More...

Public Member Functions
void	StartDestruction (bool immediate=false)
	Destroy.
void	OnRepair ()
	Revert model back to default.
void	HandleDestruction ()
	Handle destruction Must happen inside frame event, for example via SCR_MPDestructionManager.
void	DeleteSelf ()
	Deletes self.
void	Init (IEntity owner, HitZone hitZone)

Protected Member Functions
void	SetModel (ResourceName modelName, bool allowEmpty=false)
	Sets the model of the object.

Protected Attributes
ResourceName	m_sWreckModel
int	m_iWreckDelay
float	m_fDefaultWreckMass
bool	m_bDetachAfterDestroyed
bool	m_bAllowHideWreck
bool	m_bDeleteAfterParentDestroyed
bool	m_bDisablePhysicsAfterDestroyed
IEntity	m_pOwner
bool	m_bIsDestructionDelayed

Detailed Description

Base destruction handler, destruction handler types extend from this TODO: Move this to damage manager instead Ported from SCR_DestructionDamageManagerComponent.

Member Function Documentation

DeleteSelf()

void SCR_DestructionBaseHandler.DeleteSelf

(

)

Deletes self.

HandleDestruction()

void SCR_DestructionBaseHandler.HandleDestruction

(

)

Handle destruction Must happen inside frame event, for example via SCR_MPDestructionManager.

Init()

void SCR_DestructionBaseHandler.Init	(	IEntity	owner,
		HitZone	hitZone
	)

OnRepair()

void SCR_DestructionBaseHandler.OnRepair

(

)

Revert model back to default.

SetModel()

void SCR_DestructionBaseHandler.SetModel ( ResourceName  modelName, bool  allowEmpty = false  )

protected

Sets the model of the object.

Parameters

modelName	Path to model
allowEmpty	Allow setting empty model

StartDestruction()

void SCR_DestructionBaseHandler.StartDestruction

(

bool

immediate = false

)

Destroy.

Member Data Documentation

m_bAllowHideWreck

bool SCR_DestructionBaseHandler.m_bAllowHideWreck

protected

m_bDeleteAfterParentDestroyed

bool SCR_DestructionBaseHandler.m_bDeleteAfterParentDestroyed

protected

m_bDetachAfterDestroyed

bool SCR_DestructionBaseHandler.m_bDetachAfterDestroyed

protected

m_bDisablePhysicsAfterDestroyed

bool SCR_DestructionBaseHandler.m_bDisablePhysicsAfterDestroyed

protected

m_bIsDestructionDelayed

bool SCR_DestructionBaseHandler.m_bIsDestructionDelayed

protected

m_fDefaultWreckMass

float SCR_DestructionBaseHandler.m_fDefaultWreckMass

protected

m_iWreckDelay

int SCR_DestructionBaseHandler.m_iWreckDelay

protected

m_pOwner

IEntity SCR_DestructionBaseHandler.m_pOwner

protected

m_sWreckModel

ResourceName SCR_DestructionBaseHandler.m_sWreckModel

protected

---

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

• Game/Destruction/SCR_DestructionBaseHandler.c