SCR_BaseDebrisSmallEntity Interface Reference

Entity used to represent small debris in the world. More...

Inheritance diagram for SCR_BaseDebrisSmallEntity:

Public Member Functions
override void	EOnFrame (IEntity owner, float timeSlice)
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
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 Member Functions
bool	IsGamePlaying ()
	Get whether game is in play state or not.

Static Protected Member Functions
static float	GetDistanceToCamera (BaseWorld world, vector position)

Static Protected Attributes
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.

Detailed Description

Entity used to represent small debris in the world.

Is managed automatically and will never allow the user to exceed the specified maximum amount. If new spawn is requested, priority is evaluated. If the new debris has higher priority than any of the debris spawned before, it will be replaced by the new one.

Constructor & Destructor Documentation

SCR_BaseDebrisSmallEntity()

void SCR_BaseDebrisSmallEntity.SCR_BaseDebrisSmallEntity	(	IEntitySource	src,
		IEntity	parent )

Member Function Documentation

DeleteDebris()

void SCR_BaseDebrisSmallEntity.DeleteDebris

(

)

Delete debris - unregisters it from the list and makes it scale down and delete.

EOnFrame()

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

Implemented in SCR_TreeDebrisSmallEntity.

GetDistanceToCamera()

static float SCR_BaseDebrisSmallEntity.GetDistanceToCamera ( BaseWorld world, vector position )

staticprotected

IsGamePlaying()

bool SCR_BaseDebrisSmallEntity.IsGamePlaying ( )

protected

Get whether game is in play state or not.

Returns

true if play mode, false otherwise

Member Data Documentation

KINETIC_ENERGY_THRESHOLD

const float SCR_BaseDebrisSmallEntity.KINETIC_ENERGY_THRESHOLD = 15

staticprotected

Sound triggered is kinetic energy is above the threshold.

m_bDelete

bool SCR_BaseDebrisSmallEntity.m_bDelete = false

Whether this debris has reached end of its lifetime and should be deleted.

m_fAgeTime

float SCR_BaseDebrisSmallEntity.m_fAgeTime

Entity age in seconds. After this time is bigger thatn m_fLifeTime, debris will despawn.

m_fLifeTime

float SCR_BaseDebrisSmallEntity.m_fLifeTime

The lifetime in seconds.

MINIMAL_AGE

const float SCR_BaseDebrisSmallEntity.MINIMAL_AGE = 0.25

staticprotected

Minimum entity lifetime to play sound.

MINIMAL_DISTANCE_SQ

const float SCR_BaseDebrisSmallEntity.MINIMAL_DISTANCE_SQ = 0.25

staticprotected

Minimal distance from last played sound.

---

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

• Game/Entities/debris/BaseDebrisSmallEntity.c