sound.c File Reference

Go to the source code of this file.

Data Structures
class	SoundObjectBuilder
class	SoundParams
class	AbstractWave

Enumerations
enum	WaveKind

Functions
enum WaveKind	AbstractSoundScene ()
private void	~AbstractSoundScene ()
proto native AbstractWave	Play2D (SoundObject soundObject, SoundObjectBuilder soundBuilder)
proto native AbstractWave	Play3D (SoundObject soundObject, SoundObjectBuilder soundBuilder)
proto native SoundObject	BuildSoundObject (SoundObjectBuilder soundObjectbuilder)
proto native float	GetRadioVolume ()
proto native void	SetRadioVolume (float vol, float time)
proto native float	GetSpeechExVolume ()
proto native void	SetSpeechExVolume (float vol, float time)
proto native float	GetMusicVolume ()
proto native void	SetMusicVolume (float vol, float time)
proto native float	GetSoundVolume ()
proto native void	SetSoundVolume (float vol, float time)
proto native float	GetVOIPVolume ()
proto native void	SetVOIPVolume (float vol, float time)
proto native float	GetSilenceThreshold ()
proto native float	GetAudioLevel ()
class SoundObjectBuilder	SoundObject (SoundParams soundParams)
void	SoundObjectBuilder (SoundParams soundParams)
SoundObject	BuildSoundObject ()
proto native void	Initialize (SoundParams soundParams)
proto native void	AddEnvSoundVariables (vector position)
proto native void	AddVariable (string name, float value)
proto void	AddVariables (notnull array< string > names, array< float > values=null)
void	UpdateEnvSoundControllers (vector position)
	Deprecated - same functionality, just poor naming. More...
void	SetVariable (string name, float value)
	Deprecated - same functionality, just poor naming. More...
proto void	UpdateVariables (notnull array< float > values)
proto native void	SetParent (IEntity parent, int pivot=-1)
proto native IEntity	GetParent ()
	Get parent of the Effect. More...
proto native int	GetHierarchyPivot ()
proto native void	SetPosition (vector position)
	Note: Sets the position locally if parented, retrieves globally with the sound offset. More...
proto native vector	GetPosition ()
	Get the world position of the Effect. More...
proto native void	SetSpeed (vector speed)
	Note: Sets the speed locally if parented, retrieves globally with the parent speed. More...
proto native vector	GetSpeed ()
proto native void	SetOcclusionObstruction (float occlusion, float obstruction)
proto native void	SetKind (WaveKind kind)

Variables
	WAVEEFFECT
	WAVEEFFECTEX
	WAVESPEECH
	WAVEMUSIC
	WAVESPEECHEX
	WAVEENVIRONMENT
	WAVEENVIRONMENTEX
	WAVEWEAPONS
	WAVEWEAPONSEX
	WAVEATTALWAYS
	WAVEUI
class SoundParams	Event_OnSoundWaveStarted = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundWaveStopped = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundWaveLoaded = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundWaveHeaderLoaded = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundWaveEnded = new ScriptInvoker()

Enumeration Type Documentation

WaveKind

enum WaveKind

Definition at line 1 of file sound.c.

Function Documentation

AbstractSoundScene()

enum WaveKind AbstractSoundScene

(

)

Definition at line 18 of file sound.c.

AddEnvSoundVariables()

proto native void SoundObject::AddEnvSoundVariables

(

vector

position

)

AddVariable()

proto native void SoundObject::AddVariable	(	string	name,
		float	value
	)

AddVariables()

proto void SoundObject::AddVariables	(	notnull array< string >	names,
		array< float >	values = null
	)

BuildSoundObject() [1/2]

SoundObject SoundObject::BuildSoundObject

(

)

Definition at line 44 of file sound.c.

BuildSoundObject() [2/2]

proto native SoundObject BuildSoundObject

(

SoundObjectBuilder

soundObjectbuilder

)

GetAudioLevel()

proto native float GetAudioLevel

(

)

GetHierarchyPivot()

proto native int GetHierarchyPivot

(

)

GetMusicVolume()

proto native float GetMusicVolume

(

)

GetPosition()

proto native vector GetPosition

(

)

Get the world position of the Effect.

Warning

Only gets the cached variable, for immediate effect use GetCurrent variant

Returns

vector The world position of the Effect

Definition at line 9 of file undergroundarealoader.c.

GetRadioVolume()

proto native float GetRadioVolume

(

)

GetSilenceThreshold()

proto native float GetSilenceThreshold

(

)

GetSoundVolume()

proto native float GetSoundVolume

(

)

GetSpeechExVolume()

proto native float GetSpeechExVolume

(

)

GetSpeed()

proto native vector GetSpeed

(

)

GetVOIPVolume()

proto native float GetVOIPVolume

(

)

Initialize()

proto native void Initialize

(

SoundParams

soundParams

)

Play2D()

proto native AbstractWave Play2D	(	SoundObject	soundObject,
		SoundObjectBuilder	soundBuilder
	)

Play3D()

proto native AbstractWave Play3D	(	SoundObject	soundObject,
		SoundObjectBuilder	soundBuilder
	)

SetKind()

proto native void SetKind

(

WaveKind

kind

)

SetMusicVolume()

proto native void SetMusicVolume	(	float	vol,
		float	time
	)

SetOcclusionObstruction()

proto native void SetOcclusionObstruction	(	float	occlusion,
		float	obstruction
	)

SetParent()

proto native void SetParent	(	IEntity	parent,
		int	pivot = -1
	)

Note: 'SoundObject' is not an Entity, and therefore can not be accessed by using 'IEntity.GetChildren', though internally 'SoundObject.SetParent' is similiar to 'IEntity.AddChild' by creating an 'EntityHierarchyComponent'

SetRadioVolume()

proto native void SetRadioVolume	(	float	vol,
		float	time
	)

SetSoundVolume()

proto native void SetSoundVolume	(	float	vol,
		float	time
	)

SetSpeechExVolume()

proto native void SetSpeechExVolume	(	float	vol,
		float	time
	)

SetSpeed()

proto native void SetSpeed

(

vector

speed

)

Note: Sets the speed locally if parented, retrieves globally with the parent speed.

SetVariable()

void SoundObject::SetVariable	(	string	name,
		float	value
	)

Deprecated - same functionality, just poor naming.

Definition at line 62 of file sound.c.

SetVOIPVolume()

proto native void SetVOIPVolume	(	float	vol,
		float	time
	)

SoundObject()

class SoundObjectBuilder SoundObject

(

SoundParams

soundParams

)

SoundObjectBuilder()

void SoundObject::SoundObjectBuilder

(

SoundParams

soundParams

)

UpdateEnvSoundControllers()

void SoundObject::UpdateEnvSoundControllers

(

vector

position

)

Deprecated - same functionality, just poor naming.

Definition at line 56 of file sound.c.

UpdateVariables()

proto void UpdateVariables

(

notnull array< float >

values

)

~AbstractSoundScene()

private void ~AbstractSoundScene

(

)

Definition at line 19 of file sound.c.

Variable Documentation

Event_OnSoundWaveEnded

ref ScriptInvoker Event_OnSoundWaveEnded = new ScriptInvoker()

Definition at line 115 of file sound.c.

Event_OnSoundWaveHeaderLoaded

ref ScriptInvoker Event_OnSoundWaveHeaderLoaded = new ScriptInvoker()

Definition at line 114 of file sound.c.

Event_OnSoundWaveLoaded

ref ScriptInvoker Event_OnSoundWaveLoaded = new ScriptInvoker()

Definition at line 113 of file sound.c.

Event_OnSoundWaveStarted

class SoundParams Event_OnSoundWaveStarted = new ScriptInvoker()

Event_OnSoundWaveStopped

ref ScriptInvoker Event_OnSoundWaveStopped = new ScriptInvoker()

Definition at line 112 of file sound.c.

WAVEATTALWAYS

WAVEATTALWAYS

Definition at line 11 of file sound.c.

WAVEEFFECT

WAVEEFFECT

Definition at line 2 of file sound.c.

WAVEEFFECTEX

WAVEEFFECTEX

Definition at line 3 of file sound.c.

WAVEENVIRONMENT

WAVEENVIRONMENT

Definition at line 7 of file sound.c.

WAVEENVIRONMENTEX

WAVEENVIRONMENTEX

Definition at line 8 of file sound.c.

WAVEMUSIC

WAVEMUSIC

Definition at line 5 of file sound.c.

WAVESPEECH

WAVESPEECH

Definition at line 4 of file sound.c.

WAVESPEECHEX

WAVESPEECHEX

Definition at line 6 of file sound.c.

WAVEUI

WAVEUI

Definition at line 13 of file sound.c.

WAVEWEAPONS

WAVEWEAPONS

Definition at line 9 of file sound.c.

WAVEWEAPONSEX

WAVEWEAPONSEX

Definition at line 10 of file sound.c.