GetSoundProperty - Revision history

EK: Redirected page to Global Command: getSoundProperty

2023-05-19T11:25:58Z

Redirected page to Global Command: getSoundProperty

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:35Z

Vis apiuser at 16:11, 22 November 2013

2013-11-22T16:11:54Z

AFRLme at 22:11, 3 April 2013

2013-04-03T22:11:16Z

AFRLme at 21:35, 3 April 2013

2013-04-03T21:35:15Z

AFRLme at 21:33, 3 April 2013

2013-04-03T21:33:38Z

AFRLme at 17:11, 2 April 2013

2013-04-02T17:11:37Z

AFRLme at 12:18, 15 March 2013

2013-03-15T12:18:56Z

AFRLme at 12:18, 15 March 2013

2013-03-15T12:18:22Z

← Older revision		Revision as of 11:25, 19 May 2023
Line 1:		Line 1:
−	~~==getSoundProperty==~~	+	#REDIRECT [[Global Command: getSoundProperty]]
−
−	~~<div class="command-min-version-info">Available since: <span class="command-min-version">v4.0</span></div>~~
−
−	~~<div class="command-doc">Return the requested sound property</div>~~
−
−	~~Lua Syntax:~~
−	~~<pre class="command-syntax">getSoundProperty(soundID, property)</pre>~~
−	~~===Arguments===~~
−	~~====soundID====~~
−	~~:'''int''' - ID of sound to get property from.~~
−	~~====property====~~
−	:'''"string"''' - Property to retrieve.Currently supported properties: "volume" (0 mute ... 100 full volume, -1 if volume could not be retrieved), "balance" (-100 ... left, 0 ... center, +100 ... right, 0 if balance could not be retrieved), "offset" (current position from beginning of the sound in milliseconds, -1 if offset could not be retrieved), "duration" (total duration of sound in milliseconds, -1 if duration could not be retrieved), "loop" (true if sound is looped, false it is only played once, false if loop property could not be retrieved), "playing" (true if sound is currently playing, false otherwise)."paused" (true if sound is currently paused, false if sound is playing or not active at all).
−	~~===Flags===~~
−	~~===Return Values===~~
−	~~;property~~
−	~~:requested property value.~~
−	~~===Examples===~~
−	~~Example 1: store the current playtime of a sound~~
−	~~<syntaxhighlight>~~
−	~~local soundID = getSoundId('vispath~~:~~sounds/example.ogg')~~
−	~~local soundOffset =~~ getSoundProperty~~(soundID, "offset")~~
−	~~</syntaxhighlight>~~

@@ Line 1: / Line 1: @@
 ==getSoundProperty==
-<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">Return the requested sound property</div>
@@ Line 22: / Line 22: @@
 local soundOffset = getSoundProperty(soundID, "offset")
 </syntaxhighlight>

← Older revision		Revision as of 13:56, 26 November 2013
Line 22:		Line 22:
	local soundOffset = getSoundProperty(soundID, "offset")		local soundOffset = getSoundProperty(soundID, "offset")
	</syntaxhighlight>		</syntaxhighlight>
		+	[[Category:Player Commands]]

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+==getSoundProperty==
-Allows you to obtain various property values for the linked sound.id
+<div class="command-doc">Return the requested sound property</div>
+Lua Syntax:
-Syntax:
+<pre class="command-syntax">getSoundProperty(soundID, property)</pre>
-<syntaxhighlight>
+===Arguments===
-getSoundProperty(id, "property")
+====soundID====
-</syntaxhighlight>
+:'''int''' - ID of sound to get property from.
+====property====
+:'''"string"''' - Property to retrieve.Currently supported properties: "volume" (0 mute ... 100 full volume, -1 if volume could not be retrieved), "balance" (-100 ... left, 0 ... center, +100 ... right, 0 if balance could not be retrieved), "offset" (current position from beginning of the sound in milliseconds, -1 if offset could not be retrieved), "duration" (total duration of sound in milliseconds, -1 if duration could not be retrieved), "loop" (true if sound is looped, false it is only played once, false if loop property could not be retrieved), "playing" (true if sound is currently playing, false otherwise)."paused" (true if sound is currently paused, false if sound is playing or not active at all).
-Example:
+===Flags===
 <syntaxhighlight>
--- let's store the sound.id into a variable!
+local soundID = getSoundId('vispath:sounds/example.ogg')
 local soundOffset = getSoundProperty(soundID, "offset")
 </syntaxhighlight>

@@ Line 46: / Line 46: @@
 --let's check if the linked sound is looping & store the result into a variable!
 local soundLoop = getSoundProperty(soundID, "loop")
 </syntaxhighlight>

@@ Line 6: / Line 6: @@
-Allows you to obtain various property values for the linked sound ID.
+Allows you to obtain various property values for the linked sound.id
 <div class="toccolours mw-collapsible mw-collapsed tbl-ds">
 <span class="bold">Additional Info</span>

@@ Line 11: / Line 11: @@
 <div class="mw-collapsible-content">
 <div>Properties currently available:
-<pre>volume, balance, offset, duration, paused & loop</pre></div>
+<pre>volume, balance, offset, duration, playing, paused & loop</pre></div>
 </div></div>
@@ Line 37: / Line 37: @@
 -- let's store the duration of the linked sound into a variable!
 local soundDur = getSoundProperty(soundID, "duration")
 --let's check if the linked sound is paused & store the result into a variable!
@@ Line 57: / Line 60: @@
 * offset:  returns current playing time of the linked sound.id as an integer value (ms)
 * duration: returns duration of the linked sound.id as an integer value (ms)
 * paused: returns a boolean value of true or false depending on if linked sound is paused or playing
 * loop: returns a boolean value of true or false depending on if linked sound.id is set to loop or not

@@ 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 obtain various property values for the linked sound.id!
+Allows you to obtain 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 class="bold">Additional Info</span>
 <div class="mw-collapsible-content">
 <div>Properties currently available:
@@ Line 47: / Line 47: @@
-<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>property:</b> "string"
+<span class="bold">property:</span> "string"
 * volume: returns the volume level of the linked sound.id as an integer value
 * balance: returns the left/right audio balance of the linked sound.id as an integer value
@@ Line 61: / Line 61: @@
-<b><u>Flags</u></b>
+<span class="bold underline">Flags</span>
 none
-<b><u>Return</u></b>
+<span class="bold underline">Return</span>
-<b>property</b> <br/>
+<span class="bold">property</span> <br/>
 The requested property value
 {{i18n|GetSoundProperty}} <br/>
-{| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
+{| class="tbl-ds"
 |-
-|<b>Relevant Pages</b>: [[GetSoundId|getSoundId]] - [[SetSoundProperty|setSoundProperty]] - [[StartSound|startSound]] - [[StopSound|stopSound]] - [[ToggleSoundPause|toggleSoundPause]]
+|<span class="bold">Relevant Pages</span>: [[GetSoundId|getSoundId]] - [[SetSoundProperty|setSoundProperty]] - [[StartSound|startSound]] - [[StopSound|stopSound]] - [[ToggleSoundPause|toggleSoundPause]]
 |}

← Older revision		Revision as of 12:18, 15 March 2013
Line 64:		Line 64:

	none		none
		+

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