GetSoundId (CMS) - Revision history

EK: Redirected page to Global Command: getSoundId

2023-05-04T18:54:31Z

Redirected page to Global Command: getSoundId

David Stoffel: Text replacement - "{{toc}}" to ""

2014-11-03T23:50:11Z

Text replacement - "{{toc}}" to ""

AFRLme at 17:07, 28 September 2014

2014-09-28T17:07:47Z

AFRLme at 17:06, 28 September 2014

2014-09-28T17:06:48Z

AFRLme at 17:06, 28 September 2014

2014-09-28T17:06:32Z

David Stoffel at 15:26, 22 March 2014

2014-03-22T15:26:57Z

AFRLme at 14:48, 21 March 2014

2014-03-21T14:48:21Z

AFRLme at 16:09, 20 March 2014

2014-03-20T16:09:39Z

AFRLme: Created page with "
Command History

Available since ..."

2014-03-20T16:08:48Z

Created page with "<div class="toccolours mw-collapsible mw-collapsed tbl-ds"> <span class="bold">Command History</span> <div class="mw-collapsible-content"> <div class="alt-bg">Available since ..."

New page

<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
<span class="bold">Command History</span>
<div class="mw-collapsible-content">
<div class="alt-bg">Available since v3.8</div>
</div></div>

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:
<syntaxhighlight>
getSoundId("filename")
</syntaxhighlight>

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

<span class="bold underline">Arguments</span>

<span class="bold">filename</span>: path <br/>
The path to the audio file whose ID we want to obtain! ("path/filename.type")

<span class="bold underline">Flags</span>

none

<span class="bold underline">Return</span>

<span class="bold">id</span> <br/>
Returns the sound ID as an integer value.
{{i18n|GetSoundId_(CMS)}} <br/>
{| class="tbl-ds"
|-
|<span class="bold">Relevant Pages</span>: [[GetSoundProperty_(CMS)|getSoundProperty]] - [[SetSoundProperty_(CMS)|setSoundProperty]] - [[StartSound_(CMS)|startSound]] - [[StopSound_(CMS)|stopSound]] - [[ToggleSoundPause_(CMS)|toggleSoundPause]]
|}

← Older revision		Revision as of 18:54, 4 May 2023
Line 1:		Line 1:
−	~~{\| class="toccolours mw-collapsible mw-collapsed ts"~~	+	#REDIRECT [[Global_Command:_getSoundId]]
−	\|-
−	~~! 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:~~
−	~~<syntaxhighlight>~~
−	~~getSoundId("filename")~~
−	~~</syntaxhighlight>~~
−
−
−	~~Example:~~
−	~~<syntaxhighlight>~~
−	~~-- let's store the sound ID into a variable for later use~~
−	~~local soundID = getSoundId("vispath:sounds/example.ogg")~~
−	~~</syntaxhighlight>~~
−
−
−
−	~~<span class="bold underline">Arguments</span>~~
−
−	~~<span class="bold">filename</span>: path <br/>~~
−	~~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>~~
−
−
−	~~<span class="bold underline">Flags</span>~~
−
−	~~none~~
−
−
−	~~<span class="bold underline">Return</span>~~
−
−	~~<span class="bold">id</span> <br/>~~
−	~~Returns the sound ID as an integer value.~~
−	~~<br/>~~
−	~~{\| class="ts"~~
−	\|-
−	~~\| '''Relevant Pages''':~~ [[~~GetSoundProperty_(CMS)\|getSoundProperty]] - [[SetSoundProperty_(CMS)\|setSoundProperty]] - [[StartSound_(CMS)\|startSound]] - [[StopSound_(CMS)\|stopSound]] - [[ToggleSoundPause_(CMS)\|toggleSoundPause~~]]
−	\|}

← Older revision		Revision as of 23:50, 3 November 2014
Line 45:		Line 45:
	\| '''Relevant Pages''': [[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]]
	\|}		\|}
−	~~{{toc}}~~

← Older revision		Revision as of 17:07, 28 September 2014
Line 16:		Line 16:


		+	Example:
	<syntaxhighlight>		<syntaxhighlight>
	-- let's store the sound ID into a variable for later use		-- let's store the sound ID into a variable for later use

← Older revision		Revision as of 17:06, 28 September 2014
Line 44:		Line 44:
	\| '''Relevant Pages''': [[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]]
	\|}		\|}
		+	{{toc}}

@@ 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.
@@ 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]]
 |}

@@ Line 6: / Line 6: @@
-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!
+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.
@@ Line 16: / Line 16: @@
 <syntaxhighlight>
--- let's store the sound ID into a variable for later use!
+-- let's store the sound ID into a variable for later use
 local soundID = getSoundId("sounds/example.ogg")
 </syntaxhighlight>

GetSoundId (CMS) - Revision history

EK: Redirected page to Global Command: getSoundId

David Stoffel: Text replacement - "{{toc}}" to ""

AFRLme at 17:07, 28 September 2014

AFRLme at 17:06, 28 September 2014

AFRLme at 17:06, 28 September 2014

David Stoffel at 15:26, 22 March 2014

AFRLme at 14:48, 21 March 2014

AFRLme at 16:09, 20 March 2014

AFRLme: Created page with " Command History Available since ..."

AFRLme: Created page with "
Command History

Available since ..."