SCR_BuildingSoundComponent Interface Reference

Inheritance diagram for SCR_BuildingSoundComponent:

Public Member Functions
override void	UpdateSoundJob (IEntity owner, float timeSlice)
	Call when component is in range.
override void	OnUpdateSoundJobBegin (IEntity owner)
	Called when dynamic simulation is started.
void	SCR_BuildingSoundComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
Public Member Functions inherited from SoundComponent
proto external AudioHandle	SoundEvent (string eventName)
	Play a sound from the owner entity's position.
proto external AudioHandle	SoundEventTransform (string eventName, vector transf[])
	Play a sound from a set transformation.
proto external AudioHandle	SoundEventBone (string eventName, string bone)
	Play a sound from the owner entity's position.
proto external AudioHandle	SoundEventOffset (string eventName, vector offset)
	Play a sound with a given offset from the owner entity.
Public Member Functions inherited from SimpleSoundComponent
proto external void	EnableDynamicSimulation (bool value)
	Enables the dynamic simulation.
proto external void	SetScriptedMethodsCall (bool state)
	Set flag for script callbacks.
proto external bool	IsScriptedMethodsCallEnabled ()
	TRUE when flag for script callbacks is set.
proto external IEntity	GetOwner ()

Public Attributes
int	m_iTimeIntervalMin
int	m_iTimeIntervalMax
vector	m_vMins
vector	m_vMaxs

Protected Attributes
float	m_fTriggerInterval

Additional Inherited Members
Protected Member Functions inherited from SimpleSoundComponent
void	OnPostInit (IEntity owner)
	Called after all components are initialized.
void	OnInit (IEntity owner)
	Called during EOnInit.
void	OnFrame (IEntity owner, float timeSlice)
	Called during EOnFrame.
void	UpdateSoundJob (IEntity owner, float timeSlice)
	Call when component is in range.
void	OnUpdateSoundJobBegin (IEntity owner)
	Called when dynamic simulation is started.
void	OnUpdateSoundJobEnd (IEntity owner)
	Called when dynamic simulation is stopped.

Constructor & Destructor Documentation

SCR_BuildingSoundComponent()

void SCR_BuildingSoundComponent.SCR_BuildingSoundComponent	(	IEntityComponentSource	src,
		IEntity	ent,
		IEntity	parent
	)

Parameters

[in]	src
[in]	ent
[in]	parent

Member Function Documentation

OnUpdateSoundJobBegin()

override void SCR_BuildingSoundComponent.OnUpdateSoundJobBegin

(

IEntity

owner

)

Called when dynamic simulation is started.

Implements SimpleSoundComponent.

UpdateSoundJob()

override void SCR_BuildingSoundComponent.UpdateSoundJob	(	IEntity	owner,
		float	timeSlice
	)

Call when component is in range.

Implements SimpleSoundComponent.

Member Data Documentation

m_fTriggerInterval

float SCR_BuildingSoundComponent.m_fTriggerInterval

protected

m_iTimeIntervalMax

int SCR_BuildingSoundComponent.m_iTimeIntervalMax

m_iTimeIntervalMin

int SCR_BuildingSoundComponent.m_iTimeIntervalMin

m_vMaxs

vector SCR_BuildingSoundComponent.m_vMaxs

m_vMins

vector SCR_BuildingSoundComponent.m_vMins

---

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

• Game/Components/SCR_BuildingSoundComponent.c