PlaySound

2013-07-09T10:10:52Z

MrNear:

__NOTOC__
{{Client function}}
Creates a [[sound]] element and plays it immediately after creation for the local player.<br />
<br />
'''Note:''' The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT, S3M and PLS(e.g. Webstream).

==Syntax==
<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped = false ] )</syntaxhighlight>

===Required Arguments===
*'''soundPath:''' The [[filepath]] to the sound file you want to play. (Sound file has to be predefined in the [[meta.xml]] file with <file /> tag.)

===Optional Arguments===
{{OptionalArg}}
*'''looped:''' A [[boolean]] representing whether the sound will be looped. To loop the sound, use ''true''. Loop is not available for streaming sounds, only for sound files.

===Returns===
Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function wasted (killer, weapon, bodypart)
local sound = playSound("sounds/wasted.mp3") --Play wasted.mp3 from the sounds folder
setSoundVolume(sound, 0.5) -- set the sound volume to 50%
end

addEventHandler("onClientPlayerWasted", getLocalPlayer(), wasted) --add the event handler
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}
[[AR:playSound]]

Multi Theft Auto: Wiki - User contributions [en]

PlaySound