SndBaseModule Interface Reference

To create a module, you just need to create a class which inherits from BaseSndModule. More...

Inheritance diagram for SndBaseModule:

Public Member Functions
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 void	SetTransformation (vector transf[])
	Set transformation of all sounds played by this component.
proto external void	SetSoundTransformation (AudioHandle handle, vector transf[])
	Sets transformation of the sound associated with the given handle.
proto external void	UpdateTrigger ()
	Update playback of triggered sounds.
proto external bool	IsFinishedPlaying (AudioHandle handle)
	Check if sound associated with given handle has finished playing.
proto external int	GetSignalIndex (string name)
	Returns the index of the given signal name or -1 if not found.
proto external void	Terminate (AudioHandle handle)
	Terminate the sound associated with the given handle.
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)

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

Detailed Description

To create a module, you just need to create a class which inherits from BaseSndModule.

Member Function Documentation

GetSignalIndex()

proto external int SndBaseModule.GetSignalIndex

(

string

name

)

Returns the index of the given signal name or -1 if not found.

GetSndSystem()

proto external SndSystem SndBaseModule.GetSndSystem ( )

protected

IsFinishedPlaying()

proto external bool SndBaseModule.IsFinishedPlaying

(

AudioHandle

handle

)

Check if sound associated with given handle has finished playing.

OnCleanup()

void SndBaseModule.OnCleanup ( )

protected

Called before parent system is cleaned up.

OnDiag()

void SndBaseModule.OnDiag ( float timeslice )

protected

Diag for the module.

OnInit()

void SndBaseModule.OnInit ( )

protected

Called after owner system is initialized.

OnUpdate()

void SndBaseModule.OnUpdate ( float timeslice )

protected

Called after parent system is ticked.

SetSignalValue()

proto external void SndBaseModule.SetSignalValue	(	int	signal,
		float	value )

Sets signal value by index returned by GetSignalIndex(string name).

SetSignalValueStr()

proto external void SndBaseModule.SetSignalValueStr	(	string	signal,
		float	value )

Sets signal value by name.

SetSoundTransformation()

proto external void SndBaseModule.SetSoundTransformation	(	AudioHandle	handle,
		vector	transf[] )

Sets transformation of the sound associated with the given handle.

SetTransformation()

proto external void SndBaseModule.SetTransformation

(

vector

transf[]

)

Set transformation of all sounds played by this component.

SoundEvent()

proto external AudioHandle SndBaseModule.SoundEvent

(

string

eventName

)

Sound event.

Terminate()

proto external void SndBaseModule.Terminate

(

AudioHandle

handle

)

Terminate the sound associated with the given handle.

UpdateTrigger()

proto external void SndBaseModule.UpdateTrigger

(

)

Update playback of triggered sounds.

---

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

• GameLib/generated/Sound/SndBaseModule.c