SoundManagerModule Interface Reference

Inheritance diagram for SoundManagerModule:

Public Member Functions
proto external bool	PlayAudioInstanceByPos (vector pos, AudioSourceConfig conf, array< string > signalNames=null, array< float > signalValues=null, array< string > variableNames=null, array< float > variableValues=null)
proto external bool	PlayAudioInstance (IEntity owner, AudioSourceConfig conf, array< string > names=null, array< float > values=null, array< string > variableNames=null, array< float > variableValues=null)
Public Member Functions inherited from SndBaseModule
proto external AudioHandle	SoundEvent (string eventName)
	Sound event.
proto external void	SetSignalValueStr (string signal, float value)
	Sets signal value by name.
proto external void	SetSignalValue (int signal, float value)
	Sets signal value by index returned by GetSignalIndex(string name).
proto external int	GetSignalIndex (string name)
	Returns the index of the given signal name or -1 if not found.
proto external void	SetTransformation (vector transf[])
	Sets transformation of all sounds played by this component.
proto external void	UpdateTrigger ()
	Update playback of triggered sounds.
proto external void	Terminate (AudioHandle handle)
	Terminate the sound associated with the given handle.
proto external bool	IsFinishedPlaying (AudioHandle handle)
	Check if sound associated with given handle has finished playing.
proto external void	SetSoundTransformation (AudioHandle handle, vector transf[])
	Sets transformation of the sound associated with the given handle.
proto external void	SetVolume (AudioHandle handle, float volume)
	Sets the volume for a given sound.
Public Member Functions inherited from Managed
proto external ref Managed	Clone ()
	Return shallow copy of object, or null if it is not allowed (not public constructor)

Additional Inherited Members
Protected Member Functions inherited from SndBaseModule
proto external SndSystem	GetSndSystem ()
void	OnInit ()
	Called after owner system is initialized.
void	OnCleanup ()
	Called before parent system is cleaned up.
void	OnUpdate (float timeslice)
	Called after parent system is ticked.
void	OnDiag (float timeslice)
	Diag for the module.

Member Function Documentation

PlayAudioInstance()

proto external bool SoundManagerModule.PlayAudioInstance	(	IEntity	owner,
		AudioSourceConfig	conf,
		array< string >	names = null,
		array< float >	values = null,
		array< string >	variableNames = null,
		array< float >	variableValues = null )

PlayAudioInstanceByPos()

proto external bool SoundManagerModule.PlayAudioInstanceByPos	(	vector	pos,
		AudioSourceConfig	conf,
		array< string >	signalNames = null,
		array< float >	signalValues = null,
		array< string >	variableNames = null,
		array< float >	variableValues = null )

---

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

• GameLib/generated/Sound/SoundManagerModule.c