StopSound: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: __NOTOC__ {{Client function}} Stops any created sound. ==Syntax== <syntaxhighlight lang="lua">bool stopSound ( string sound )</syntaxhighlight> ===Required Arguments=== *'''sound:''' Name of the sound you wan...)
 
mNo edit summary
 
(16 intermediate revisions by 12 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
Stops any created sound.
Stops the sound playback for specified [[sound]] [[element]]. The sound element is also destroyed.


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


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


==Example==  
==Example==  
TODO
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
function startMySound()
    sound = playSound( "sound.mp3", true )
end
addEventHandler( "onClientResourceStart", resourceRoot, startMySound )
 
function stopMySound()
    stopSound( sound )
end
addCommandHandler ( "stopsound", stopMySound ) --using the command 'stopsound' will stop the sound
</syntaxhighlight>
</syntaxhighlight>
</section>


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

Latest revision as of 22:30, 25 January 2019

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

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

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

See Also