Difference between revisions of "StopSound"

From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 20: Line 20:
 
stopSound(soundID)
 
stopSound(soundID)
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
[[Category:Player Commands]]

Revision as of 15:57, 26 November 2013

stopSound

Available since: v3.8
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)