CustomSound

Sound typessource

Handle to a loaded sound, can be used to play the sound and receive a PlayingSound for more control It is up to you to not release this as long as any sounds returned by CustomSound:play() are still playing

Methods

get_parameters

function CustomSound:get_parameters(): table<integer, string>

Returns table<integer, string>

source

play

function CustomSound:play(): PlayingSound

Returns PlayingSound

function CustomSound:play(paused: boolean): PlayingSound

paused: boolean

Returns PlayingSound

function CustomSound:play(paused: boolean, sound_type: SOUND_TYPE): PlayingSound

paused: boolean

sound_type: SOUND_TYPE

Returns PlayingSound

source