Difference between revisions of "StopSound"

From The Official Visionaire Studio: Adventure Game Engine Wiki
(Created page with "<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"> <b>Command History</b> <div class="mw-collapsible-co...")
 
Line 22: Line 22:
 
Example 2: again using sound.id via a variable!
 
Example 2: again using sound.id via a variable!
 
<syntaxhighlight>
 
<syntaxhighlight>
 +
-- let's store the sound.id for example.ogg inside of a variable!
 
local soundID = getSoundId("sounds/example.ogg")
 
local soundID = getSoundId("sounds/example.ogg")
 
stopSound(soundID)
 
stopSound(soundID)

Revision as of 18:56, 8 March 2013

Command History

Available since v3.8


Allows you to stop any playing sound files!


Syntax:

stopSound(id)


Example 1: basic stop audio file method! (!awful code)

stopSound(getSoundId("sounds/example.ogg"))

Example 2: again using sound.id via a variable!

-- let's store the sound.id for example.ogg inside of a variable!
local soundID = getSoundId("sounds/example.ogg")
stopSound(soundID)


Arguments

id: integer (number)
The id for the currently playing audio file! ("sound.id")


Flags

none


Return

none


Relevant Pages: getSoundId - getSoundProperty - setSoundProperty - stopSound - toggleSoundPause