AmbientSoundsComponent Interface Reference

Inheritance diagram for AmbientSoundsComponent:

Public Member Functions
proto external void	QueryAmbientSoundsBySphere (float radius, EQueryEntitiesFlags queryFlags=EQueryEntitiesFlags.ALL)
proto external void	GetAmbientSoundsCountPerType (out notnull array< int > count)
proto external vector	GetCameraOrigin ()
proto external bool	GetRiver (const vector pos, out notnull array< float > count)
proto external IEntity	GetRandomTree (int index, float minHeight)
proto external void	GetClosestEntities (int soundTypeIdx, int nEntities, out notnull array< IEntity > output)
proto void	TracePointToTerrain (const vector point, inout int iSoundGroup)
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 ()

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.

Member Function Documentation

GetAmbientSoundsCountPerType()

proto external void AmbientSoundsComponent.GetAmbientSoundsCountPerType

(

out notnull array< int >

count

)

GetCameraOrigin()

proto external vector AmbientSoundsComponent.GetCameraOrigin

(

)

GetClosestEntities()

proto external void AmbientSoundsComponent.GetClosestEntities	(	int	soundTypeIdx,
		int	nEntities,
		out notnull array< IEntity >	output
	)

GetRandomTree()

proto external IEntity AmbientSoundsComponent.GetRandomTree	(	int	index,
		float	minHeight
	)

GetRiver()

proto external bool AmbientSoundsComponent.GetRiver	(	const vector	pos,
		out notnull array< float >	count
	)

QueryAmbientSoundsBySphere()

proto external void AmbientSoundsComponent.QueryAmbientSoundsBySphere	(	float	radius,
		EQueryEntitiesFlags	queryFlags = EQueryEntitiesFlags.ALL
	)

TracePointToTerrain()

proto void AmbientSoundsComponent.TracePointToTerrain	(	const vector	point,
		inout int	iSoundGroup
	)

---

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

• Game/generated/Components/AmbientSoundsComponent.c