SCR_DebrisSmallEntity Interface Reference

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

Inheritance diagram for SCR_DebrisSmallEntity:

Additional Inherited Members
Public Member Functions inherited from SCR_BaseDebrisSmallEntity
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 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 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)
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.

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.

---

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

• Game/Entities/debris/DebrisSmallEntity.c