StopSound: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(11 intermediate revisions by 10 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
Stops the sound playback for specified [[sound]] element. The sound element is also destroyed.
Stops the sound playback for specified [[sound]] [[element]]. The sound element is also destroyed.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">bool stopSound ( element theSound )</syntaxhighlight>  
<syntaxhighlight lang="lua">bool stopSound ( element theSound )</syntaxhighlight>  
 
{{OOP||[[sound]]:stop}}
===Required Arguments===  
===Required Arguments===  
*'''theSound:''' The [[sound]] element you want to stop playing.
*'''theSound:''' the [[sound]] [[element]] you want to stop playing.


===Returns===
===Returns===
Line 13: Line 13:


==Example==  
==Example==  
TODO
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
local sound
function startMySound()
function startMySound()
     sound = playSound( "sound.mp3", true )
     sound = playSound("sound.mp3", true)
end
end
addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource() ), startMySound )
addEventHandler("onClientResourceStart", resourceRoot, startMySound)


function stopMySound()
function stopMySound()
     stopSound( sound )
     if isElement(sound) then
        stopSound(sound)
    end
end
end
addCommandHandler ( "stopsound", stopMySound ) --using the command 'stopsound' will stop the sound
addCommandHandler("stopsound", stopMySound) --using the command 'stopsound' will stop the sound
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Client_audio_functions}}
{{Client_audio_functions}}
[[HU:stopSound]]
[[AR:stopSound]]
[[RO:stopSound]]

Latest revision as of 15:16, 2 January 2026

Stops the sound playback for specified sound element. The sound element is also destroyed.

Syntax

bool stopSound ( element theSound )

OOP Syntax Help! I don't understand this!

Method: sound:stop(...)


Required Arguments

Returns

Returns true if the sound was successfully stopped, false otherwise.

Example

local sound

function startMySound()
    sound = playSound("sound.mp3", true)
end
addEventHandler("onClientResourceStart", resourceRoot, startMySound)

function stopMySound()
    if isElement(sound) then
        stopSound(sound)
    end
end
addCommandHandler("stopsound", stopMySound) --using the command 'stopsound' will stop the sound

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/StopSound?oldid=82677"