Difference between revisions of "StopSound"

From The Official Visionaire Studio: Adventure Game Engine Wiki
(Redirected page to Global Command: startSound)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
==stopSound==
+
#REDIRECT [[Global Command: startSound]]
 
 
<div class="command-min-version-info">Available since: <span class="command-min-version">v3.8</span></div>
 
 
 
<div class="command-doc">Stops the specified sound.</div>
 
 
 
Lua Syntax:
 
<pre class="command-syntax">stopSound(soundID)</pre>
 
===Arguments===
 
====soundID====
 
:'''int''' - ID of the sound which should be stopped
 
===Flags===
 
===Return Values===
 
;status
 
:True if sound was stopped successfully, false otherwise.
 
===Examples===
 
Example 1:
 
<syntaxhighlight>
 
local soundID = getSoundId('vispath:sounds/example.ogg')
 
stopSound(soundID)
 
</syntaxhighlight>
 
[[Category:Player Commands]]
 

Latest revision as of 13:37, 19 May 2023