SoundController API

Classes

AbstractSoundScene AbstractWave AbstractWaveEvents SoundObject SoundObjectBuilder SoundParams

Enums

Values

`Limit`		more…
`None`
`Overwrite`

Functions

`private void ~AbstractSoundScene()`
`private void ~AbstractWave()`DIAG_DEVELOPER
`private void AbstractSoundScene()`
`private void AbstractWave()`		more…
`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)`
`proto native SoundObject BuildSoundObject(SoundObjectBuilder soundObjectbuilder)` [1/2]
`SoundObject BuildSoundObject()` [2/2]		more…
`proto native float GetAudioLevel()`
`proto float GetCurrPosition()`	Current position in percentage of total length
`AbstractWaveEvents GetEvents()`		more…
`proto float GetFrequency()`
`proto native int GetHierarchyPivot()`
`proto float GetLength()`	WARNING: Blocking! Waits for header to load
`proto native float GetMusicVolume()`
`proto string GetName()`
`proto native IEntity GetParent()`
`proto native vector GetPosition()`
`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()`
`private void InitEvents()`		more…
`proto native void Initialize(SoundParams soundParams)` [1/2]
`proto native void Initialize(SoundParams soundParams)` [2/2]
`proto bool IsHeaderLoaded()`
`proto native bool IsValid()`
`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()`		more…
`void OnHeaderLoad()`		more…
`void OnLoad()`		more…
`void OnPlay()`		more…
`void OnStop()`		more…
`proto void Play()`
`proto native AbstractWave Play2D(SoundObject soundObject, SoundObjectBuilder soundBuilder)`
`proto native AbstractWave Play3D(SoundObject soundObject, SoundObjectBuilder soundBuilder)`
`void PlayWithOffset(float offset)`		more…
`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 void SetPosition(vector position, vector velocity = "0 0 0")` [1/2]
`proto native void SetPosition(vector position)` [2/2]	Note: Sets the position locally if parented, retrieves globally with the sound offset
`proto native void SetRadioVolume(float vol, float time)`
`proto native void SetSoundControllerOverride(string controllerName, float value, SoundControllerAction action)`		more…
`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	more…
`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)`
`void SoundObjectBuilder(SoundParams soundParams)`
`void SoundParams(string name)`
`proto void Stop()`
`void UpdateEnvSoundControllers(vector position)`	Deprecated - same functionality, just poor naming	more…
`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()`