StopSound: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(OOP)
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===

Revision as of 17:29, 17 October 2014

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

Click to collapse [-]
Client
function startMySound()
    sound = playSound( "sound.mp3", true )
end
addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource() ), startMySound )

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

See Also