SndBaseModule Class Reference

Inheritance diagram for SndBaseModule:

Protected Member Functions
SndSystem	GetSndSystem ()
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.
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.
SndSystem	GetSndSystem ()
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.
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.

Definition at line 15 of file SndBaseModule.c.

Member Function Documentation

GetSignalIndex() [1/2]

proto external int SndBaseModule::GetSignalIndex ( string name )

protected

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

GetSignalIndex() [2/2]

proto external int SndBaseModule::GetSignalIndex ( string name )

protected

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

GetSndSystem() [1/2]

SndSystem SndBaseModule::GetSndSystem ( )

protected

GetSndSystem() [2/2]

SndSystem SndBaseModule::GetSndSystem ( )

protected

IsFinishedPlaying() [1/2]

proto external bool SndBaseModule::IsFinishedPlaying ( AudioHandle handle )

protected

Check if sound associated with given handle has finished playing.

IsFinishedPlaying() [2/2]

proto external bool SndBaseModule::IsFinishedPlaying ( AudioHandle handle )

protected

Check if sound associated with given handle has finished playing.

OnCleanup() [1/2]

void SndBaseModule::OnCleanup ( )

protected

Called before parent system is cleaned up.

OnCleanup() [2/2]

void SndBaseModule::OnCleanup ( )

protected

Called before parent system is cleaned up.

OnDiag() [1/2]

void SndBaseModule::OnDiag ( float timeslice )

protected

Diag for the module.

OnDiag() [2/2]

void SndBaseModule::OnDiag ( float timeslice )

protected

Diag for the module.

OnInit() [1/2]

void SndBaseModule::OnInit ( )

protected

Called after owner system is initialized.

OnInit() [2/2]

void SndBaseModule::OnInit ( )

protected

Called after owner system is initialized.

OnUpdate() [1/2]

void SndBaseModule::OnUpdate ( float timeslice )

protected

Called after parent system is ticked.

OnUpdate() [2/2]

void SndBaseModule::OnUpdate ( float timeslice )

protected

Called after parent system is ticked.

SetSignalValue() [1/2]

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

protected

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

SetSignalValue() [2/2]

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

protected

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

SetSignalValueStr() [1/2]

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

protected

Sets signal value by name.

SetSignalValueStr() [2/2]

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

protected

Sets signal value by name.

SetSoundTransformation() [1/2]

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

protected

Sets transformation of the sound associated with the given handle.

SetSoundTransformation() [2/2]

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

protected

Sets transformation of the sound associated with the given handle.

SetTransformation() [1/2]

proto external void SndBaseModule::SetTransformation ( vector transf[] )

protected

Sets transformation of all sounds played by this component.

SetTransformation() [2/2]

proto external void SndBaseModule::SetTransformation ( vector transf[] )

protected

Sets transformation of all sounds played by this component.

SetVolume() [1/2]

proto external void SndBaseModule::SetVolume ( AudioHandle handle, float volume )

protected

Sets the volume for a given sound.

SetVolume() [2/2]

proto external void SndBaseModule::SetVolume ( AudioHandle handle, float volume )

protected

Sets the volume for a given sound.

SoundEvent() [1/2]

proto external AudioHandle SndBaseModule::SoundEvent ( string eventName )

protected

Sound event.

SoundEvent() [2/2]

proto external AudioHandle SndBaseModule::SoundEvent ( string eventName )

protected

Sound event.

Terminate() [1/2]

proto external void SndBaseModule::Terminate ( AudioHandle handle )

protected

Terminate the sound associated with the given handle.

Terminate() [2/2]

proto external void SndBaseModule::Terminate ( AudioHandle handle )

protected

Terminate the sound associated with the given handle.

UpdateTrigger() [1/2]

proto external void SndBaseModule::UpdateTrigger ( )

protected

Update playback of triggered sounds.

UpdateTrigger() [2/2]

proto external void SndBaseModule::UpdateTrigger ( )

protected

Update playback of triggered sounds.

---

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

• scripts/GameLib/generated/Sound/SndBaseModule.c