sound.c File Reference

Go to the source code of this file.

Data Structures
class	AbstractSoundScene
class	AbstractWaveEvents
class	SoundObject

Enumerations
enum	WaveKind

Functions
void	~AbstractSoundScene ()
void	AbstractSoundScene ()
void	AbstractWave ()
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)
SoundObject	BuildSoundObject ()
proto native SoundObject	BuildSoundObject (SoundObjectBuilder soundObjectbuilder)
proto native float	GetAudioLevel ()
proto float	GetCurrPosition ()
	Current position in percentage of total length.
AbstractWaveEvents	GetEvents ()
proto float	GetFrequency ()
proto native int	GetHierarchyPivot ()
proto float	GetLength ()
	WARNING: Blocking! Waits for header to load.
proto native float	GetMusicVolume ()
proto string	GetName ()
	Test name getter. Strictly for UI porposes!
proto native IEntity	GetParent ()
	Get parent of the Effect.
proto native vector	GetPosition ()
	Get the world position of the Effect.
proto native float	GetRadioVolume ()
proto native float	GetSilenceThreshold ()
proto native float	GetSoundVolume ()
proto native float	GetSpeechExVolume ()
proto native vector	GetSpeed ()
proto Managed	GetUserData ()
proto native float	GetVOIPVolume ()
proto float	GetVolume ()
class AbstractWaveEvents	InitEvents ()
proto native void	Initialize (SoundParams soundParams)
proto bool	IsHeaderLoaded ()
proto native bool	IsValid ()
	Checks if the ScriptCaller is valid.
proto native bool	Load (string name)
proto void	Loop (bool setLoop)
proto native void	MuteAllSoundControllers ()
	Overrides all the environment controllers to be muted.
void	OnEnd ()
void	OnHeaderLoad ()
void	OnLoad ()
void	OnPlay ()
void	OnStop ()
proto void	Play ()
proto native AbstractWave	Play2D (SoundObject soundObject, SoundObjectBuilder soundBuilder)
proto native AbstractWave	Play3D (SoundObject soundObject, SoundObjectBuilder soundBuilder)
void	PlayWithOffset (float offset)
proto native void	ResetAllSoundControllers ()
	Removes all the previously set overrides of sound controllers.
proto void	Restart ()
proto void	SetDoppler (bool setDoppler)
proto void	SetFadeInFactor (float volume)
proto void	SetFadeOutFactor (float volume)
proto void	SetFrequency (float value)
proto native void	SetKind (WaveKind kind)
proto native void	SetMusicVolume (float vol, float time)
proto native void	SetOcclusionObstruction (float occlusion, float obstruction)
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'.
proto native void	SetPosition (vector position)
	Note: Sets the position locally if parented, retrieves globally with the sound offset.
proto void	SetPosition (vector position, vector velocity="0 0 0")
proto native void	SetRadioVolume (float vol, float time)
	SetSoundControllerOverride (string controllerName, float value, SoundControllerAction action)
	Overrides or limits soundmap value for a sound cotroller.
proto native void	SetSoundVolume (float vol, float time)
proto native void	SetSpeechExVolume (float vol, float time)
proto native void	SetSpeed (vector speed)
	Note: Sets the speed locally if parented, retrieves globally with the parent speed.
proto void	SetStartOffset (float offset)
proto void	SetUserData (Managed inst)
void	SetVariable (string name, float value)
	Deprecated - same functionality, just poor naming.
proto native void	SetVOIPVolume (float vol, float time)
proto void	SetVolume (float value)
proto void	SetVolumeRelative (float value)
proto void	Skip (float timeSec)
void	SoundObject (SoundParams soundParams)
class AbstractSoundScene	SoundObjectBuilder (SoundParams soundParams)
class SoundObject	SoundParams (string name)
proto void	Stop ()
	Stops all elements this effect consists of.
void	UpdateEnvSoundControllers (vector position)
	Deprecated - same functionality, just poor naming.
proto void	UpdateVariables (notnull array< float > values)

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

Enumeration Type Documentation

WaveKind

enum WaveKind

Definition at line 1 of file sound.c.