Difference between revisions of "GetSoundId (CMS)"

Revision as of 18:06, 28 September 2014

Function History
Available since v4.0

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("vispath:sounds/example.ogg")

Arguments

filename: path
The path to the audio file whose ID we want to obtain; vispath: must be included at the beginning of the path.

"vispath:path/filename.type"

Flags

none

Return

id
Returns the sound ID as an integer value.

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

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+{| class="toccolours mw-collapsible mw-collapsed ts"
-<span class="bold">Function History</span>
+|-
-<div class="mw-collapsible-content">
+! Function History
-<div class="alt-bg">Available since v3.8</div>
+|-
-</div></div>
+| Available since v4.0
+|}
@@ Line 17: / Line 18: @@
 <syntaxhighlight>
 -- let's store the sound ID into a variable for later use
-local soundID = getSoundId("sounds/example.ogg")
+local soundID = getSoundId("vispath:sounds/example.ogg")
 </syntaxhighlight>
@@ Line 25: / Line 26: @@
 <span class="bold">filename</span>: path <br/>
-The path to the audio file whose ID we want to obtain! ("path/filename.type")
+The path to the audio file whose ID we want to obtain; '''vispath:''' must be included at the beginning of the path.
+<syntaxhighlight>"vispath:path/filename.type"</syntaxhighlight>
@@ Line 38: / Line 40: @@
 Returns the sound ID as an integer value.
 <br/>
-{| class="tbl-ds"
+{| class="ts"
 |-
-|<span class="bold">Relevant Pages</span>: [[GetSoundProperty_(CMS)|getSoundProperty]] - [[SetSoundProperty_(CMS)|setSoundProperty]] - [[StartSound_(CMS)|startSound]] - [[StopSound_(CMS)|stopSound]] - [[ToggleSoundPause_(CMS)|toggleSoundPause]]
+| '''Relevant Pages''': [[GetSoundProperty_(CMS)|getSoundProperty]] - [[SetSoundProperty_(CMS)|setSoundProperty]] - [[StartSound_(CMS)|startSound]] - [[StopSound_(CMS)|stopSound]] - [[ToggleSoundPause_(CMS)|toggleSoundPause]]
 |}