SCR_TriggerSoundComponent Interface Reference

Inheritance diagram for SCR_TriggerSoundComponent:

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_TriggerSoundComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
void	~SCR_TriggerSoundComponent ()
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 ()

Protected Attributes
string	m_sSoundEvent
float	m_fTriggerDistanceMin
float	m_fTriggerDistanceMax
int	m_iRepCount
int	m_iRepCountRnd
int	m_iRepTime
int	m_iRepTimeRnd
int	m_iSequenceRepTime
int	m_iSequenceRepTimeRnd
float	m_fTime
float	m_fTriggerTime
int	m_iRepCountCurent

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_TriggerSoundComponent()

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

~SCR_TriggerSoundComponent()

void SCR_TriggerSoundComponent.~SCR_TriggerSoundComponent

(

)

Member Function Documentation

OnUpdateSoundJobBegin()

override void SCR_TriggerSoundComponent.OnUpdateSoundJobBegin

(

IEntity

owner

)

Called when dynamic simulation is started.

Implements SimpleSoundComponent.

UpdateSoundJob()

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

Call when component is in range.

Implements SimpleSoundComponent.

Member Data Documentation

m_fTime

float SCR_TriggerSoundComponent.m_fTime

protected

m_fTriggerDistanceMax

float SCR_TriggerSoundComponent.m_fTriggerDistanceMax

protected

m_fTriggerDistanceMin

float SCR_TriggerSoundComponent.m_fTriggerDistanceMin

protected

m_fTriggerTime

float SCR_TriggerSoundComponent.m_fTriggerTime

protected

m_iRepCount

int SCR_TriggerSoundComponent.m_iRepCount

protected

m_iRepCountCurent

int SCR_TriggerSoundComponent.m_iRepCountCurent

protected

m_iRepCountRnd

int SCR_TriggerSoundComponent.m_iRepCountRnd

protected

m_iRepTime

int SCR_TriggerSoundComponent.m_iRepTime

protected

m_iRepTimeRnd

int SCR_TriggerSoundComponent.m_iRepTimeRnd

protected

m_iSequenceRepTime

int SCR_TriggerSoundComponent.m_iSequenceRepTime

protected

m_iSequenceRepTimeRnd

int SCR_TriggerSoundComponent.m_iSequenceRepTimeRnd

protected

m_sSoundEvent

string SCR_TriggerSoundComponent.m_sSoundEvent

protected

---

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

• Game/Components/SCR_TriggerSoundComponent.c