SimpleSoundComponent Interface Reference

Inheritance diagram for SimpleSoundComponent:

Public Member Functions
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 Member Functions
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.

Member Function Documentation

EnableDynamicSimulation()

proto external void SimpleSoundComponent.EnableDynamicSimulation

(

bool

value

)

Enables the dynamic simulation.

GetOwner()

proto external IEntity SimpleSoundComponent.GetOwner

(

)

IsScriptedMethodsCallEnabled()

proto external bool SimpleSoundComponent.IsScriptedMethodsCallEnabled

(

)

TRUE when flag for script callbacks is set.

OnFrame()

void SimpleSoundComponent.OnFrame ( IEntity  owner, float  timeSlice  )

protected

Called during EOnFrame.

Parameters

owner	Entity this component is attached to.
timeSlice	Delta time since last update.

OnInit()

void SimpleSoundComponent.OnInit ( IEntity  owner )

protected

Called during EOnInit.

Parameters

owner

Entity this component is attached to.

Implemented in SCR_AmbientSoundsComponent, SCR_BellSoundComponent, SCR_CampaignSoundComponent, SCR_HelicopterSoundComponent, and SCR_VehicleSoundComponent.

OnPostInit()

void SimpleSoundComponent.OnPostInit ( IEntity  owner )

protected

Called after all components are initialized.

Parameters

owner

Entity this component is attached to.

Implemented in SCR_AmbientSoundsComponent, SCR_BellSoundComponent, SCR_CharacterSoundComponent, SCR_CommunicationSoundComponent, SCR_ShellSoundComponent, and SCR_HelicopterSoundComponent.

OnUpdateSoundJobBegin()

void SimpleSoundComponent.OnUpdateSoundJobBegin ( IEntity  owner )

protected

Called when dynamic simulation is started.

Implemented in SCR_BellSoundComponent, SCR_BuildingSoundComponent, SCR_ShellSoundComponent, and SCR_TriggerSoundComponent.

OnUpdateSoundJobEnd()

void SimpleSoundComponent.OnUpdateSoundJobEnd ( IEntity  owner )

protected

Called when dynamic simulation is stopped.

SetScriptedMethodsCall()

proto external void SimpleSoundComponent.SetScriptedMethodsCall

(

bool

state

)

Set flag for script callbacks.

UpdateSoundJob()

void SimpleSoundComponent.UpdateSoundJob ( IEntity  owner, float  timeSlice  )

protected

Call when component is in range.

Implemented in SCR_AmbientSoundsComponent, SCR_BellSoundComponent, SCR_BuildingSoundComponent, SCR_CharacterSoundComponent, SCR_ShellSoundComponent, SCR_TriggerSoundComponent, and SCR_HelicopterSoundComponent.

---

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

• Game/generated/Components/SimpleSoundComponent.c