GetSoundId - Revision history

EK: Redirected page to Global Command: getSoundId

2023-05-19T11:25:39Z

Redirected page to Global Command: getSoundId

Vis apiuser at 20:27, 30 September 2014

2014-09-30T20:27:50Z

Vis apiuser at 13:56, 26 November 2013

2013-11-26T13:56:32Z

Vis apiuser at 16:11, 22 November 2013

2013-11-22T16:11:53Z

AFRLme at 15:45, 2 April 2013

2013-04-02T15:45:46Z

AFRLme at 21:38, 13 March 2013

2013-03-13T21:38:15Z

AFRLme at 21:36, 13 March 2013

2013-03-13T21:36:31Z

AFRLme: Created page with "
Command History

2013-03-13T21:13:07Z

Created page with "<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"> <b>Command History</b> <div class="mw-collapsible-co..."

New page
<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
<b>Command History</b>
<div class="mw-collapsible-content">
<div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.8</span></div>
</div></div>

Allows you to play sound files; with optional property values!
<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
<b>Additional Info</b>
<div class="mw-collapsible-content">
<div>Properties currently available:
<pre>volume, balance, offset & loop</pre>
Please note that only mono sounds can be panned using the balance property; all stereo channel sounds will be centered!</div>
</div></div>

Syntax:
<syntaxhighlight>
startSound("filename", {flags=1, properties})
</syntaxhighlight>

Example 1: basic play audio file method!
<syntaxhighlight>
startSound("sounds/example.ogg")
</syntaxhighlight>

Example 2: again with properties!
<syntaxhighlight>
-- play example.ogg at 100% volume level, audio centered, from 1 second mark with loop mode on!
startSound("sounds/example.ogg", {flags=1, volume=100, balance=0, offset=1000 loop=true})

--[[
let's say you have an audio file with a duration of 00:03:24 & you want to start the audio file at: 2 minutes & 44 seconds;
so what we need to do is convert minutes/seconds into ms like so: (260)1000 + (441000) = 164000ms

math explanation:
2m60s = 120 seconds * 1000ms = 120,000ms | 44s1000ms = 44,000ms
120,000 + 44,000 = 164,000ms
--]]
</syntaxhighlight>

<b><u>Arguments</u></b>

<b>filename</b>: path <br/>
The path to the audio file to be played! ("path/filename.type")

<b><u>Flags</u></b>

<b>properties</b>
volume: allows you to set volume level via an integer value
* balance: allows you to set the left/right audio balance via an integer value (-1000/0/1000)
* offset: allows you to start audio file from x time via an integer value (in ms)
* loop: allows you to declare if audio file should loop via a boolean value (true/false)

<b><u>Return</u></b>

none
{{i18n|StartSound}} <br/>
{| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
|-
|<b>Relevant Pages</b>: [[GetSoundProperty|getSoundProperty]] - [[SetSoundProperty|setSoundProperty]] - [[StartSound|startSound]] - [[StopSound|stopSound]] - [[ToggleSoundPause|toggleSoundPause]]
|}

← Older revision		Revision as of 11:25, 19 May 2023
Line 1:		Line 1:
−	~~==getSoundId==~~	+	#REDIRECT [[Global Command: getSoundId]]
−
−	~~<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>~~
−
−	~~Lua Syntax:~~
−	~~<pre class="command-syntax">getSoundId(sounditem)</pre>~~
−	~~===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~~:
−	~~<syntaxhighlight>~~
−	~~-- store sound id of a currently active sound in a local variable~~
−	~~local soundID =~~ getSoundId~~('vispath:sounds/example.ogg')~~
−	~~</syntaxhighlight>~~

@@ Line 1: / Line 1: @@
 ==getSoundId==
-<div class="command-min-version-info">Available since: <span class="command-min-version">v3.8</span></div>
+<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>
@@ Line 20: / Line 20: @@
 local soundID = getSoundId('vispath:sounds/example.ogg')
 </syntaxhighlight>

← Older revision		Revision as of 13:56, 26 November 2013
Line 20:		Line 20:
	local soundID = getSoundId('vispath:sounds/example.ogg')		local soundID = getSoundId('vispath:sounds/example.ogg')
	</syntaxhighlight>		</syntaxhighlight>
		+	[[Category:Player Commands]]

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+==getSoundId==
-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!
+<div class="command-doc">Gets the sound ID of the specified sound if it is currently active.</div>
 <syntaxhighlight>
--- let's store the sound ID into a variable for later use!
+-- store sound id of a currently active sound in a local variable
-local soundID = getSoundId("sounds/example.ogg")
+local soundID = getSoundId('vispath:sounds/example.ogg')
 </syntaxhighlight>

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
+<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
-<b>Command History</b>
+<span class="bold">Command History</span>
 <div class="mw-collapsible-content">
-<div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.8</span></div>
+<div class="alt-bg">Available since v3.8</div>
 </div></div>
@@ Line 23: / Line 23: @@
-<b><u>Arguments</u></b>
+<span class="bold underline">Arguments</span>
-<b>filename</b>: path <br/>
+<span class="bold">filename</span>: path <br/>
 The path to the audio file whose ID we want to obtain! ("path/filename.type")
-<b><u>Flags</u></b>
+<span class="bold underline">Flags</span>
 none
-<b><u>Return</u></b>
+<span class="bold underline">Return</span>
-<b>id</b> <br/>
+<span class="bold">id</span> <br/>
 Returns the sound ID as an integer value.
 {{i18n|GetSoundId}} <br/>
-{| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
+{| class="tbl-ds"
 |-
-|<b>Relevant Pages</b>: [[GetSoundProperty|getSoundProperty]] - [[SetSoundProperty|setSoundProperty]] - [[StartSound|startSound]] - [[StopSound|stopSound]] - [[ToggleSoundPause|toggleSoundPause]]
+|<span class="bold">Relevant Pages</span>: [[GetSoundProperty|getSoundProperty]] - [[SetSoundProperty|setSoundProperty]] - [[StartSound|startSound]] - [[StopSound|stopSound]] - [[ToggleSoundPause|toggleSoundPause]]
 |}

← Older revision		Revision as of 21:38, 13 March 2013
Line 6:		Line 6:


−	Use this to store the sound.id for an audio file into a variable, which you can use ~~for stopping~~/~~pausing said sound~~ or ~~editing~~ the 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!