Difference between revisions of "GetSoundId (CMS)"

From The Official Visionaire Studio: Adventure Game Engine Wiki
m
Line 1: Line 1:
 
<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
 
<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
<span class="bold">Command History</span>
+
<span class="bold">Function History</span>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
<div class="alt-bg">Available since v3.8</div>
 
<div class="alt-bg">Available since v3.8</div>

Revision as of 16:48, 21 March 2014

Function History

Available since v3.8


Use this to store the sound.id for an audio file into a variable; which you can use to stop/pause/resume or edit the linked sounds properties.


Syntax:

getSoundId("filename")


-- let's store the sound ID into a variable for later use
local soundID = getSoundId("sounds/example.ogg")


Arguments

filename: path
The path to the audio file whose ID we want to obtain! ("path/filename.type")


Flags

none


Return

id
Returns the sound ID as an integer value.


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