SOUND

Audio playback and control.

Availability: Client-only

Methods

SOUND.play2D

client

Play a 2D sound effect (not positional)

Signature: obj action(num, num, num, bool)

Parameters:

NameTypeDescription
aidnumSound asset ID
volnumVolume level (0-1)
ratenumPlayback rate multiplier
loopboolWhether to loop the sound

Returns: obj - Sound control object with volume, rate, fade, play, stop, pause, mute, unmute methods

obj result = GAME.SOUND.play2D("asset_id", 1.0, 1.0, true);

SOUND.play3D

client

Play a 3D positional sound at a specific location

Signature: obj action(num, num, num, num, num, num, bool)

Parameters:

NameTypeDescription
aidnumSound asset ID
volnumVolume level (0-1)
xnumX position in 3D space
ynumY position in 3D space
znumZ position in 3D space
ratenumPlayback rate multiplier
loopboolWhether to loop the sound

Returns: obj - Sound control object

obj result = GAME.SOUND.play3D("asset_id", 1.0, 0, 10, 0, 1.0, true);

SOUND.stop

client

Stop a currently playing sound

Signature: action(num)

Parameters:

NameTypeDescription
aidnumSound asset ID to stop
GAME.SOUND.stop("asset_id");