Difference between revisions of "StopSound"
From The Official Visionaire Studio: Adventure Game Engine Wiki
| Line 1: | Line 1: | ||
==stopSound== | ==stopSound== | ||
| − | <div class="command-min-version-info">Available since: <span class="command-min-version"> | + | <div class="command-min-version-info">Available since: <span class="command-min-version">v4.0</span></div> |
<div class="command-doc">Stops the specified sound.</div> | <div class="command-doc">Stops the specified sound.</div> | ||
| Line 20: | Line 20: | ||
stopSound(soundID) | stopSound(soundID) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
Revision as of 22:28, 30 September 2014
stopSound
Available since: v4.0
Stops the specified sound.
Lua Syntax:
stopSound(soundID)
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:
local soundID = getSoundId('vispath:sounds/example.ogg')
stopSound(soundID)