Skip to main content

Audio

Client

Methods​

AudioSource PlaySound(Asset sound, Vec3? position, number? volume, boolean? loop)​

Play a sound at a position, with volume and loop. Only single channel audio. Returns AudioSource

AudioSource PlaySoundRelative(Asset sound, Vec3? position, number? volume, boolean? loop)​

AudioMusic PlayMusic(Asset music, number? volume, boolean? loop)​

Play music with volume and loop. This plays stereo music without any position, just like a normal audio player. Returns AudioMusic

AudioMusic PrepareMusic(Asset music, number? volume, boolean? loop)​

nil PauseAudio()​

Pause all playing sounds and music

nil ResumeAudio()​

Resume all paused sounds and music

nil StopAudio()​

Properties​

number masterVolume​

Audio volume in range 0 - 1.

number soundVolume​

Audio volume in range 0 - 1.

number musicVolume​

Audio volume in range 0 - 1.