SCR_LoopedPositionalSounds Interface Reference

Handles looped sounds such as leaves rustles, or crickets played on entities close to camera. More...

Inheritance diagram for SCR_LoopedPositionalSounds:

Public Member Functions
override void	Update (float worldTime, vector cameraPos)
override void	OnPostInit (SCR_AmbientSoundsComponent ambientSoundsComponent, SignalsManagerComponent signalsManagerComponent)
Public Member Functions inherited from SCR_AmbientSoundsEffect
void	Update (float worldTime, vector cameraPos)
void	OnPostInit (SCR_AmbientSoundsComponent ambientSoundsComponent, SignalsManagerComponent signalsManagerComponent)
void	OnInit ()

Protected Member Functions
void	GetTreeProperties (IEntity entity, out ETreeSoundTypes soundType, out float foliageHeight)
string	GetTreeSoundEventName (float foliageHeight, ETreeSoundTypes treeSoundType)

Additional Inherited Members
Protected Attributes inherited from SCR_AmbientSoundsEffect
SCR_AmbientSoundsComponent	m_AmbientSoundsComponent
SignalsManagerComponent	m_LocalSignalsManager

Detailed Description

Handles looped sounds such as leaves rustles, or crickets played on entities close to camera.

Member Function Documentation

GetTreeProperties()

void SCR_LoopedPositionalSounds.GetTreeProperties ( IEntity  entity, out ETreeSoundTypes  soundType, out float  foliageHeight  )

protected

GetTreeSoundEventName()

string SCR_LoopedPositionalSounds.GetTreeSoundEventName ( float  foliageHeight, ETreeSoundTypes  treeSoundType  )

protected

OnPostInit()

override void SCR_LoopedPositionalSounds.OnPostInit	(	SCR_AmbientSoundsComponent	ambientSoundsComponent,
		SignalsManagerComponent	signalsManagerComponent
	)

Parameters

[in]	ambientSoundsComponent
[in]	signalsManagerComponent

Implements SCR_AmbientSoundsEffect.

Update()

override void SCR_LoopedPositionalSounds.Update	(	float	worldTime,
		vector	cameraPos
	)

Parameters

[in]	worldTime
[in]	cameraPos

Implements SCR_AmbientSoundsEffect.

---

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

• Game/Components/AmbientSoundsComponent/SCR_LoopedPositionalSounds.c