Difference between revisions of "GetSoundId"
From The Official Visionaire Studio: Adventure Game Engine Wiki
| Line 20: | Line 20: | ||
local soundID = getSoundId('vispath:sounds/example.ogg') | local soundID = getSoundId('vispath:sounds/example.ogg') | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| + | [[Category:Player Commands]] | ||
Revision as of 14:56, 26 November 2013
getSoundId
Available since: v3.8
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')