Skip to content

sound Module#

Sound and music helpers.

Functions#


exit#

Unknown.

sound.exit()

getDevices#

Unknown.

sound.getDevices()

getLayouts#

Unknown.

sound.getLayouts()

getWaveInfo#

Unknown.

sound.getWaveInfo(...)

init#

Unknown.

sound.init(...)

pauseMusic#

Pauses the current music.

sound.pauseMusic()

playMusic#

Plays a playlist.

sound.playMusic(playlist)
Parameter Type Required Description
playlist table<string> Yes Table of filenames.

playPreview#

Plays a preview of a sound file.

sound.playPreview(filename)

playSound#

Plays an ogg or wav sound file.

sound.playSound(filename)

resumeMusic#

Resumes the current music.

sound.resumeMusic()

setEffectsGain#

Sets effects gain.

sound.setEffectsGain(gain)

setMusicGain#

Sets music gain.

sound.setMusicGain(gain)

stopMusic#

Stops the current music.

sound.stopMusic()

stopPreview#

Stops the preview.

sound.stopPreview()

update#

Unknown.

sound.update(...)

updateSettings#

Unknown.

sound.updateSettings(...)