Sound Functions
Functions to play sounds and music, change their volume, time and pitch.
playSound
playSound(sound:String,
?volume:Float = 1,
?tag:String = null,
?loop:Bool = false):String
Plays a sound, set a Tag to be able to use any functions on it.
Calls function "onSoundFinished(tag)" when it finishes if "tag" isn't null.
Returns the Sound's formatted Tag if tag isn't null, otherwise returns null.
- sound - Sound path inside "sounds/" folder, don't include the extension!
- volume (Optional) - Ranges from 0 to 1, defaults to 1.
- tag (Optional) - Lua Sound nametag to save.
- loop (Optional) - Should sound loop indefinitely?
Examples:
- playSound('confirmMenu', 0.4) - Plays "assets/shared/sounds/confirmMenu.ogg".
- playSound('custom_sound', 0.4, 'mySound') - Plays "mods/My-Mod/sounds/custom_sound.ogg" and save it to "mySound" tag.
playMusic
playMusic(music:String,
?volume:Float = 1,
?loop:Bool = false):Void
Plays a music, used for Pre/Post Song cutscenes.
- music - Music path inside "music/" folder, don't include the extension!
- volume (Optional) - Ranges from 0 to 1, defaults to 1.
- loop (Optional) - Should sound loop indefinitely?
Examples:
- playMusic('breakfast') - Plays "assets/shared/music/breakfast.ogg".
soundFadeIn
soundFadeIn(tag:String,
duration:Float,
?fromValue:Float = 0,
?toValue:Float = 1):Void
Tweens the volume from a Lua Sound with a specific tag doing a Fade In.
- tag - Lua Sound nametag, use "null" for the Music from "playMusic".
- duration - Tween duration.
- fromValue - Tween initial volume.
- toValue - Tween target volume.
Examples:
- soundFadeIn('mySound', 0.5) - Fades "mySound" Lua Sound in 0.5 seconds.
- soundFadeIn(_, 0.5) - Fades background music in 0.5 seconds.
soundFadeOut
soundFadeOut(tag:String,
duration:Float,
?toValue:Float = 0):Void
Tweens the volume from a Lua Sound with a specific tag doing a Fade Out.
- tag - Lua Sound nametag, use "null" for the Music from "playMusic".
- duration - Tween duration.
- toValue - Tween target volume.
soundFadeCancel
soundFadeCancel(tag:String):Void
Stops the Fade In/Out of a Lua Sound with a specific tag.
- tag - Lua Sound nametag, use "null" for the Music from "playMusic".
stopSound
stopSound(tag:String):Void
Interrupts and clears a Lua Sound with a specific tag.
- tag - Lua Sound nametag, use "null" for the Music from "playMusic".
pauseSound
pauseSound(tag:String):Void
Pauses a Lua Sound with a specific tag.
- tag - Lua Sound nametag, use "null" for the Music from "playMusic".
resumeSound
resumeSound(tag:String):Void
Resumes a Lua Sound with a specific tag.
- tag - Lua Sound nametag, use "null" for the Music from "playMusic".
luaSoundExists
luaSoundExists(tag:String):Bool
Returns whether a Lua Sound with a specific tag exists.
getSoundVolume
getSoundVolume(tag:String):Float
Returns a Lua Sound's volume, if missing, it returns 0.
- tag - Lua Sound nametag, use "null" for the Music from "playMusic".
setSoundVolume
setSoundVolume(tag:String, value:Float):Void
Sets a Lua Sound's volume.
- tag - Lua Sound nametag, use "null" for the Music from "playMusic".
- value - Volume to set it to, ranges from 0 to 1.
getSoundTime
getSoundTime(tag:String):Float
Returns a Lua Sound's time position, if missing, it returns 0.
- tag - Lua Sound nametag, use "null" for the Music from "playMusic".
setSoundTime
setSoundTime(tag:String, value:Float):Void
Sets a Lua Sound's time position.
- tag - Lua Sound nametag, use "null" for the Music from "playMusic".
- value - Time to set it to, in milliseconds.
getSoundPitch
getSoundPitch(tag:String):Float
Returns a Lua Sound's pitch shift, if missing, it returns 1.
- tag - Lua Sound nametag, use "null" for the Music from "playMusic".
setSoundPitch
setSoundPitch(tag:String, value:Float, ?doPause:Bool = false):Void
Sets a Lua Sound's pitch shift.
- tag - Lua Sound nametag, use "null" for the Music from "playMusic".
- value - Pitch to set it to.
- doPause (Optional) - Pauses and resumes sound while changing pitch, might be needed to update the Pitch properly unless the sound is already paused.