SCR_BellSoundComponent Interface Reference

Inheritance diagram for SCR_BellSoundComponent:

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.
override void	OnPostInit (IEntity owner)
	Called after all components are initialized.
override void	OnInit (IEntity owner)
	Called during EOnInit.
void	SCR_BellSoundComponent (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
ref array< ref SCR_SoundBellTime >	m_aSoundBellTime

Protected Attributes
float	m_fTimer
float	m_fTimeOfDayValueLast
int	m_iBellTimeIdx = -1
int	m_iSoundBellTimeCount
int	m_iRepetitionCount

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

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

Parameters

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

Member Function Documentation

OnInit()

override void SCR_BellSoundComponent.OnInit

(

IEntity

owner

)

Called during EOnInit.

Parameters

owner

Entity this component is attached to.

Implements SimpleSoundComponent.

OnPostInit()

override void SCR_BellSoundComponent.OnPostInit

(

IEntity

owner

)

Called after all components are initialized.

Parameters

owner

Entity this component is attached to.

Implements SimpleSoundComponent.

OnUpdateSoundJobBegin()

override void SCR_BellSoundComponent.OnUpdateSoundJobBegin

(

IEntity

owner

)

Called when dynamic simulation is started.

Implements SimpleSoundComponent.

UpdateSoundJob()

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

Call when component is in range.

Implements SimpleSoundComponent.

Member Data Documentation

m_aSoundBellTime

ref array<ref SCR_SoundBellTime> SCR_BellSoundComponent.m_aSoundBellTime

m_fTimeOfDayValueLast

float SCR_BellSoundComponent.m_fTimeOfDayValueLast

protected

m_fTimer

float SCR_BellSoundComponent.m_fTimer

protected

m_iBellTimeIdx

int SCR_BellSoundComponent.m_iBellTimeIdx = -1

protected

m_iRepetitionCount

int SCR_BellSoundComponent.m_iRepetitionCount

protected

m_iSoundBellTimeCount

int SCR_BellSoundComponent.m_iSoundBellTimeCount

protected

---

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

• Game/Components/SCR_BellSoundComponent.c