SetSoundProperty - Revision history

EK: Redirected page to Global Command: setSoundProperty

2023-05-19T11:31:07Z

Redirected page to Global Command: setSoundProperty

Vis apiuser at 20:28, 30 September 2014

2014-09-30T20:28:00Z

Vis apiuser at 13:56, 26 November 2013

2013-11-26T13:56:54Z

Vis apiuser at 16:12, 22 November 2013

2013-11-22T16:12:15Z

AFRLme at 00:09, 5 April 2013

2013-04-05T00:09:22Z

AFRLme at 16:26, 3 April 2013

2013-04-03T16:26:16Z

AFRLme at 16:24, 3 April 2013

2013-04-03T16:24:47Z

AFRLme at 18:10, 14 March 2013

2013-03-14T18:10:27Z

AFRLme at 16:50, 14 March 2013

2013-03-14T16:50:18Z

AFRLme at 16:47, 14 March 2013

2013-03-14T16:47:59Z

← Older revision		Revision as of 11:31, 19 May 2023
Line 1:		Line 1:
−	~~==setSoundProperty==~~	+	#REDIRECT [[Global Command: setSoundProperty]]
−
−	~~<div class="command-min-version-info">Available since: <span class="command-min-version">v4.0</span></div>~~
−
−	~~<div class="command-doc">Sets properties of the specified sound.</div>~~
−
−	~~Lua Syntax:~~
−	~~<pre class="command-syntax">setSoundProperty(soundID, {flags=1,~~
−	~~volume = int,~~
−	~~balance = int,~~
−	~~loop = true\|false,~~
−	~~offset = int})</pre>~~
−	~~===Arguments===~~
−	~~====soundID====~~
−	~~:'''int''' - ID specifying sound where properties will be set.~~
−	~~===Flags===~~
−	~~====vol/volume====~~
−
−	~~:Set sound volume (0 ... mute, 100 ... full volume).~~
−	~~====bal/balance====~~
−
−	~~:Set sound balance (-100 ... left, 0 ... center, +100 right).~~
−	~~====lop/loop====~~
−
−	~~:If true then loop sound, otherwise play it only once.~~
−	~~====ofs/offset====~~
−
−	~~:Set the sound to a specific offset (seek) in milliseconds.~~
−	~~===Return Values===~~
−	~~;status~~
−	~~:True if properties were set successfully, false if setting properties failed.~~
−	~~===Examples===~~
−	~~Example 1:~~
−	~~<syntaxhighlight>~~
−	~~local soundID = getSoundId('vispath~~:~~sounds/example.ogg')~~
−
−	setSoundProperty~~(soundID, {flags=1, volume=80, balance=20}~~
−	~~</syntaxhighlight>~~

@@ Line 1: / Line 1: @@
 ==setSoundProperty==
-<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">Sets properties of the specified sound.</div>
@@ Line 37: / Line 37: @@
 setSoundProperty(soundID, {flags=1, volume=80, balance=20}
 </syntaxhighlight>

← Older revision		Revision as of 13:56, 26 November 2013
Line 37:		Line 37:
	setSoundProperty(soundID, {flags=1, volume=80, balance=20}		setSoundProperty(soundID, {flags=1, volume=80, balance=20}
	</syntaxhighlight>		</syntaxhighlight>
		+	[[Category:Player Commands]]

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+==setSoundProperty==
-Allows you to set various property values for the linked sound.id!
+<div class="command-doc">Sets properties of the specified sound.</div>
-Syntax:
+:Set sound volume (0 ... mute, 100 ... full volume).
-<syntaxhighlight>
+====bal/balance====
-setSoundProperty(id, {flags=1, properties})
-</syntaxhighlight>
+:Set sound balance (-100 ... left, 0 ... center, +100 right).
-Example:
+:Set the sound to a specific offset (seek) in milliseconds.
 <syntaxhighlight>
--- let's store the sound.id into a variable!
+local soundID = getSoundId('vispath:sounds/example.ogg')
--- set the linked sound property values to:  volume=80%, audio=centered, keep current offset with loop mode on!
+setSoundProperty(soundID, {flags=1, volume=80, balance=20}
 </syntaxhighlight>

@@ Line 43: / Line 43: @@
 <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 51: / Line 51: @@
 none
-{{i18n|GetSoundProperty}} <br/>
+{{i18n|SetSoundProperty}} <br/>
 {| class="tbl-ds"
 |-
 |<span class="bold">Relevant Pages</span>: [[GetSoundId|getSoundId]] - [[GetSoundProperty|GetSoundProperty]] - [[StartSound|startSound]] - [[StopSound|stopSound]] - [[ToggleSoundPause|toggleSoundPause]]
 |}

@@ 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 set various property values for the linked sound.id!
-<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>Additional Info</span>
 <div class="mw-collapsible-content">
 <div>Properties currently available:
@@ Line 27: / Line 27: @@
 local soundID = getSoundId("sounds/example.ogg")
--- set the linked sound property values to:  volume=80%, audio=centered, duration at 3 seconds, keep current offset with loop mode on!
+-- set the linked sound property values to:  volume=80%, audio=centered, keep current offset with loop mode on!
-setSoundProperty(soundID, {flags=1, volume=100, balance=0, duration=3000, offset=0, loop=true})
+setSoundProperty(soundID, {flags=1, volume=100, balance=0, offset=0, loop=true})
 </syntaxhighlight>
-<b><u>Arguments</u></b>
+<span class="bold underline">Arguments</span>
-<b>id</b>: integer (number) <br/>
+<span class="bold">id</span>: integer (number) <br/>
 The id for the currently playing audio file! ("sound.id")
-<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)
 * 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>
+<span class="bold underline">Return</span>
 none
 {{i18n|GetSoundProperty}} <br/>
-{| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
+{| class="tbl-ds"
 |-
-|<b>Relevant Pages</b>: [[GetSoundId|getSoundId]] - [[GetSoundProperty|GetSoundProperty]] - [[StartSound|startSound]] - [[StopSound|stopSound]] - [[ToggleSoundPause|toggleSoundPause]]
+|<span class="bold">Relevant Pages</span>: [[GetSoundId|getSoundId]] - [[GetSoundProperty|GetSoundProperty]] - [[StartSound|startSound]] - [[StopSound|stopSound]] - [[ToggleSoundPause|toggleSoundPause]]
 |}

@@ Line 28: / Line 28: @@
 -- set the linked sound property values to:  volume=80%, audio=centered, keep current offset with loop mode on!
-setSoundProperty("sounds/example.ogg", {flags=1, volume=100, balance=0, offset=0 loop=true})
+setSoundProperty(soundID, {flags=1, volume=100, balance=0, offset=0 loop=true})
 </syntaxhighlight>