SoundSystem

System managing available Sounds and actively playing audio.  Note that most gameplay audio interaction will happen via a GameObject’s SoundComponent.

Summary
SoundSystemSystem managing available Sounds and actively playing audio.
Functions
NKGet3DSoundRetrieve a loaded 3D Sound by name.
NKGetAmbientSoundRetrieve a loaded ambient Sound by name.
NKIsInitializedReturns the initialization state of this system.
NKUpdateSoundVolumeUpdates the system’s volume level for the given type of sound.

Functions

NKGet3DSound

Retrieve a loaded 3D Sound by name.

Parameters

stringThe name of the 3D Sound to retrieve.

Returns

SoundThe retrieved sound, or nil if the sound was not found.

NKGetAmbientSound

Retrieve a loaded ambient Sound by name.

Parameters

stringThe name of the ambient Sound to retrieve.

Returns

SoundThe retrieved sound, or nil if the sound was not found.

NKIsInitialized

Returns the initialization state of this system.  The engine may optionally be launched with the sound disabled, in which case this function will return false.

Returns

boolIf true, the sound system is fully initialized.

NKUpdateSoundVolume

Updates the system’s volume level for the given type of sound.

Parameters

floatThe new volume level
intIndex representing the type of sound.  0 is 3d sound, 1 is ambient.
Close