Difference between revisions of "GetSoundId"
From The Official Visionaire Studio: Adventure Game Engine Wiki
| Line 1: | Line 1: | ||
==getSoundId== | ==getSoundId== | ||
| − | <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">Gets the sound ID of the specified sound if it is currently active.</div> | <div class="command-doc">Gets the sound ID of the specified sound if it is currently active.</div> | ||
| Line 20: | Line 20: | ||
local soundID = getSoundId('vispath:sounds/example.ogg') | local soundID = getSoundId('vispath:sounds/example.ogg') | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
Revision as of 21:27, 30 September 2014
getSoundId
Available since: v4.0
Gets the sound ID of the specified sound if it is currently active.
Lua Syntax:
getSoundId(sounditem)
Arguments
sounditem
- "string" (string should contain 'vispath:' prefix) - Relative filename of sound.
Flags
Return Values
- soundID
- Unique id referencing the requested sound or -1 if the sound is not active.
Examples
Example 1:
-- store sound id of a currently active sound in a local variable
local soundID = getSoundId('vispath:sounds/example.ogg')