StartSound - Revision history

EK: Redirected page to Global Command: startSound

2023-05-19T11:35:55Z

Redirected page to Global Command: startSound

Vis apiuser at 20:28, 30 September 2014

2014-09-30T20:28:14Z

Vis apiuser at 13:57, 26 November 2013

2013-11-26T13:57:13Z

Vis apiuser at 16:12, 22 November 2013

2013-11-22T16:12:37Z

AFRLme at 00:08, 5 April 2013

2013-04-05T00:08:15Z

AFRLme at 12:12, 4 April 2013

2013-04-04T12:12:54Z

AFRLme at 16:49, 14 March 2013

2013-03-14T16:49:47Z

AFRLme at 16:42, 14 March 2013

2013-03-14T16:42:02Z

AFRLme at 15:06, 10 March 2013

2013-03-10T15:06:38Z

AFRLme at 15:05, 10 March 2013

2013-03-10T15:05:27Z

← Older revision		Revision as of 11:35, 19 May 2023
Line 1:		Line 1:
−	~~==startSound==~~	+	#REDIRECT [[Global Command: startSound]]
−
−	~~<div class="command-min-version-info">Available since: <span class="command-min-version">v4.0</span></div>~~
−
−	~~<div class="command-doc">Plays a sound file.</div>~~
−
−	~~Lua Syntax~~:
−	~~<pre class="command-syntax">~~startSound~~(sounditem, {flags=1,~~
−	~~volume = int,~~
−	~~balance = int,~~
−	~~loop = true\|false,~~
−	~~offset = int})</pre>~~
−	~~===Arguments===~~
−	~~====sounditem====~~
−	~~:'''"string" (string should contain 'vispath:' prefix)''' - Relative filename of sound which should be started.~~
−	~~===Flags===~~
−	~~====vol/volume====~~
−
−	~~:Sound volume (0 ... mute, 100 ... full volume), default value is 100.~~
−	~~====bal/balance====~~
−
−	~~:Sound balance (-100 ... left, 0 ... center, +100 right), default value is 0.~~
−	~~====lop/loop====~~
−
−	~~:If true then loop sound, otherwise play it only once (default).~~
−	~~====ofs/offset====~~
−
−	~~:Set the sound to a specific offset (seek) in milliseconds. Default value is 0.~~
−	~~===Return Values===~~
−	~~;soundID~~
−	~~:Unique id referencing the started sound or -1 if the sound could not be started.~~
−	~~===Examples===~~
−	~~Example 1: play audio file, store sound id (for later use) and update sound balance of currently started sound~~
−	~~<syntaxhighlight>~~
−	~~local soundId = startSound('vispath:sounds/example.ogg')~~
−	~~setSoundProperty(soundId, {flags=1, balance=40})~~
−	~~</syntaxhighlight>~~
−	~~Example 2: play audio file and set volume, balance and offset~~
−	~~<syntaxhighlight>~~
−	~~startSound('vispath:sounds/example.ogg', {flags=1, volume=70, balance=-10, offset=1000})~~
−	~~</syntaxhighlight>~~

@@ Line 1: / Line 1: @@
 ==startSound==
-<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">Plays a sound file.</div>
@@ Line 40: / Line 40: @@
 startSound('vispath:sounds/example.ogg', {flags=1, volume=70, balance=-10, offset=1000})
 </syntaxhighlight>

← Older revision		Revision as of 13:57, 26 November 2013
Line 40:		Line 40:
	startSound('vispath:sounds/example.ogg', {flags=1, volume=70, balance=-10, offset=1000})		startSound('vispath:sounds/example.ogg', {flags=1, volume=70, balance=-10, offset=1000})
	</syntaxhighlight>		</syntaxhighlight>
		+	[[Category:Player Commands]]

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+==startSound==
-Allows you to play sound files; with optional property values!
+<div class="command-doc">Plays a sound file.</div>
-Syntax:
+:Sound volume (0 ... mute, 100 ... full volume), default value is 100.
-<syntaxhighlight>
+====bal/balance====
-startSound("filename", {flags=1, properties})
-</syntaxhighlight>
+:Sound balance (-100 ... left, 0 ... center, +100 right), default value is 0.
-Example 1: basic play audio file method!
+:Set the sound to a specific offset (seek) in milliseconds. Default value is 0.
 <syntaxhighlight>
-startSound("sounds/example.ogg")
+local soundId = startSound('vispath:sounds/example.ogg')
 </syntaxhighlight>
+Example 2: play audio file and set volume, balance and offset
 <syntaxhighlight>
--- play example.ogg at 100% volume level, audio centered, from 1 second mark with loop mode on!
+startSound('vispath:sounds/example.ogg', {flags=1, volume=70, balance=-10, offset=1000})
 </syntaxhighlight>

@@ Line 54: / Line 54: @@
 <span class="bold">properties</span>
 * 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)
+* balance: allows you to set the left/right audio balance via an integer value (-100 to 100, 0 is centered)
 * 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)

@@ 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>
 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%">
+<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
-<b>Additional Info</b>
+<span class="bold">Additional Info</span>
 <div class="mw-collapsible-content">
 <div>Properties currently available:
@@ Line 44: / Line 44: @@
-<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 to be played! ("path/filename.type")
-<b><u>Flags</u></b>
+<span class="bold underline">Flags</span>
-<b>properties</b>
+<span class="bold">properties</span>
 * 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)
@@ Line 59: / Line 59: @@
-<b><u>Return</u></b>
+<span class="bold underline">Return</span>
 none
 {{i18n|StartSound}} <br/>
-{| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
+{| class="tbl-ds"
 |-
-|<b>Relevant Pages</b>: [[GetSoundId|getSoundId]] - [[GetSoundProperty|getSoundProperty]] - [[SetSoundProperty|setSoundProperty]] - [[StopSound|stopSound]] - [[ToggleSoundPause|toggleSoundPause]]
+|<span class="bold">Relevant Pages</span>: [[GetSoundId|getSoundId]] - [[GetSoundProperty|getSoundProperty]] - [[SetSoundProperty|setSoundProperty]] - [[StopSound|stopSound]] - [[ToggleSoundPause|toggleSoundPause]]
 |}

@@ Line 30: / Line 30: @@
 <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})
+startSound("sounds/example.ogg", {flags=1, volume=100, balance=0, offset=1000, loop=true})
 --[[

@@ Line 12: / Line 12: @@
 <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>
+Please note that only mono sounds can be panned using the balance property; all stereo channel sounds will remain centered!</div>
 </div></div>