IsSoundFinished

2014-10-20T09:57:50Z

GERgta: /* Example */

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function check if sound finish.

==Syntax==
<syntaxhighlight lang="lua">bool isSoundFinished ( element theSound )</syntaxhighlight>

===Required Arguments===
* '''theSound''': The sound element which finish state you want to return.

===Returns===
Returns ''true'' if the [[sound]] element is finished, ''false'' if unfinished or invalid arguments were passed.

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function isSoundFinished(theSound)
local length = getSoundLength(theSound)
local post = getSoundPosition(theSound)
if (post == length) then
return true
end
return false
end
</syntaxhighlight>
</section>

==Example==
This example will check and see if the sound is finished or not, and tell the player.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("checkfinish",
function ()
local sound = playSound("music/song.mp3")
if (isSoundFinished(sound)) then
outputChatBox("The sound is finished!")
else
outputChatBox("The sound is not finished!")
end
end)
</syntaxhighlight>
</section>

'''Author:''' WASSIm.

==See Also==
{{Useful_Functions}}

Multi Theft Auto: Wiki - User contributions [en]

IsSoundFinished