SCR_TreeDebrisSmallEntity Interface Reference

Inheritance diagram for SCR_TreeDebrisSmallEntity:

Public Member Functions
void	SCR_TreeDebrisSmallEntity (IEntitySource src, IEntity parent)
override void	EOnContact (IEntity owner, IEntity other, Contact contact)
void	PlaySound (vector pos, float dVelocity)
override void	EOnFrame (IEntity owner, float timeSlice)
override void	EOnInit (IEntity owner)
	On initialization the debris is registered into the list.
override void	EOnPhysicsActive (IEntity owner, bool activeState)
Public Member Functions inherited from SCR_BaseDebrisSmallEntity
void	DeleteDebris ()
	Delete debris - unregisters it from the list and makes it scale down and delete.
void	SCR_BaseDebrisSmallEntity (IEntitySource src, IEntity parent)

Public Attributes
float	m_fTimeToDespawn
int	m_iDespawnRandomizationTime
float	m_fMaxDistance
ref SCR_AudioSourceConfiguration	m_audioSourceConfigurationImpact
ref SCR_AudioSourceConfiguration	m_audioSourceConfigurationBreak
Public Attributes inherited from SCR_BaseDebrisSmallEntity
bool	m_bDelete = false
	Whether this debris has reached end of its lifetime and should be deleted.
float	m_fLifeTime
	The lifetime in seconds.
float	m_fAgeTime
	Entity age in seconds. After this time is bigger thatn m_fLifeTime, debris will despawn.

Protected Attributes
vector	m_vSoundPositionLast
	Position of last played sound.
float	m_fEntityDimensionMax
	"Scaling factor" based on entity size
float	m_fMinimalDistance
	Minimum distance to last sound based on entitySize.
float	m_fSoundCoolDownEnd
	Cooldown time based on entitySize.
float	m_fSoundThreshold
	Sound threshold.
AudioHandle	m_AudioHandleDebrisImpact = AudioHandle.Invalid
	Stores debris impact sound.
AudioHandle	m_AudioHandleDebrisBreak = AudioHandle.Invalid
	Stores debris break sound.

Static Protected Attributes
static const float	TREE_KINETIC_ENERGY_THRESHOLD = 20
	Sound triggered is kinetic energy is above the threshold.
static const float	DEBRIS_BREAK_TIME_MIN = 0.7
	Debris break deletion minimum time.
static const float	ENTITY_SIZE_FACTOR = 0.06
	Entity size factor.
Static Protected Attributes inherited from SCR_BaseDebrisSmallEntity
static const float	MINIMAL_DISTANCE_SQ = 0.25
	Minimal distance from last played sound.
static const float	MINIMAL_AGE = 0.25
	Minimum entity lifetime to play sound.
static const float	KINETIC_ENERGY_THRESHOLD = 15
	Sound triggered is kinetic energy is above the threshold.

Additional Inherited Members
Protected Member Functions inherited from SCR_BaseDebrisSmallEntity
bool	IsGamePlaying ()
	Get whether game is in play state or not.
Static Protected Member Functions inherited from SCR_BaseDebrisSmallEntity
static float	GetDistanceToCamera (BaseWorld world, vector position)

Constructor & Destructor Documentation

SCR_TreeDebrisSmallEntity()

void SCR_TreeDebrisSmallEntity.SCR_TreeDebrisSmallEntity	(	IEntitySource	src,
		IEntity	parent )

Member Function Documentation

EOnContact()

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

EOnFrame()

override void SCR_TreeDebrisSmallEntity.EOnFrame	(	IEntity	owner,
		float	timeSlice )

Implements SCR_BaseDebrisSmallEntity.

EOnInit()

override void SCR_TreeDebrisSmallEntity.EOnInit

(

IEntity

owner

)

On initialization the debris is registered into the list.

EOnPhysicsActive()

override void SCR_TreeDebrisSmallEntity.EOnPhysicsActive	(	IEntity	owner,
		bool	activeState )

PlaySound()

void SCR_TreeDebrisSmallEntity.PlaySound	(	vector	pos,
		float	dVelocity )

Member Data Documentation

DEBRIS_BREAK_TIME_MIN

const float SCR_TreeDebrisSmallEntity.DEBRIS_BREAK_TIME_MIN = 0.7

staticprotected

Debris break deletion minimum time.

ENTITY_SIZE_FACTOR

const float SCR_TreeDebrisSmallEntity.ENTITY_SIZE_FACTOR = 0.06

staticprotected

Entity size factor.

m_AudioHandleDebrisBreak

AudioHandle SCR_TreeDebrisSmallEntity.m_AudioHandleDebrisBreak = AudioHandle.Invalid

protected

Stores debris break sound.

m_AudioHandleDebrisImpact

AudioHandle SCR_TreeDebrisSmallEntity.m_AudioHandleDebrisImpact = AudioHandle.Invalid

protected

Stores debris impact sound.

m_audioSourceConfigurationBreak

ref SCR_AudioSourceConfiguration SCR_TreeDebrisSmallEntity.m_audioSourceConfigurationBreak

m_audioSourceConfigurationImpact

ref SCR_AudioSourceConfiguration SCR_TreeDebrisSmallEntity.m_audioSourceConfigurationImpact

m_fEntityDimensionMax

float SCR_TreeDebrisSmallEntity.m_fEntityDimensionMax

protected

"Scaling factor" based on entity size

m_fMaxDistance

float SCR_TreeDebrisSmallEntity.m_fMaxDistance

m_fMinimalDistance

float SCR_TreeDebrisSmallEntity.m_fMinimalDistance

protected

Minimum distance to last sound based on entitySize.

m_fSoundCoolDownEnd

float SCR_TreeDebrisSmallEntity.m_fSoundCoolDownEnd

protected

Cooldown time based on entitySize.

m_fSoundThreshold

float SCR_TreeDebrisSmallEntity.m_fSoundThreshold

protected

Sound threshold.

m_fTimeToDespawn

float SCR_TreeDebrisSmallEntity.m_fTimeToDespawn

m_iDespawnRandomizationTime

int SCR_TreeDebrisSmallEntity.m_iDespawnRandomizationTime

m_vSoundPositionLast

vector SCR_TreeDebrisSmallEntity.m_vSoundPositionLast

protected

Position of last played sound.

TREE_KINETIC_ENERGY_THRESHOLD

const float SCR_TreeDebrisSmallEntity.TREE_KINETIC_ENERGY_THRESHOLD = 20

staticprotected

Sound triggered is kinetic energy is above the threshold.

---

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

• Game/Entities/debris/TreeDebrisSmallEntity.c