ToggleSoundPause - Revision history

EK: Redirected page to Global Command: toggleSoundPause

2023-05-19T11:37:27Z

Redirected page to Global Command: toggleSoundPause

Vis apiuser at 20:28, 30 September 2014

2014-09-30T20:28:20Z

Vis apiuser at 13:57, 26 November 2013

2013-11-26T13:57:21Z

Vis apiuser at 16:12, 22 November 2013

2013-11-22T16:12:49Z

AFRLme at 12:26, 5 April 2013

2013-04-05T12:26:54Z

AFRLme at 18:16, 14 March 2013

2013-03-14T18:16:11Z

AFRLme at 18:15, 14 March 2013

2013-03-14T18:15:34Z

AFRLme: Created page with "
Command History

2013-03-14T18:14:41Z

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 stop any playing sound files!

Syntax:
<syntaxhighlight>
stopSound(id)
</syntaxhighlight>

Example 1: basic toggle pause/resume audio file method! (!messy)
<syntaxhighlight>
toggleSoundPause(getSoundId("sounds/example.ogg"))
</syntaxhighlight>

Example 2: again using sound.id via a variable!
<syntaxhighlight>
-- let's store the sound.id for example.ogg inside of a variable!
local soundID = getSoundId("sounds/example.ogg")
toggleSoundPause(soundID)
</syntaxhighlight>

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

<b>id</b>: integer (number) <br/>
The id for the currently playing audio file! ("sound.id")

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

none

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

<b>success</b>
Returns true or false boolean value depending on if the linked sound was successfully paused or resumed!
{{i18n|ToggleSoundPause}} <br/>
{| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
|-
|<b>Relevant Pages</b>: [[GetSoundId|getSoundId]] - [[GetSoundProperty|getSoundProperty]] - [[SetSoundProperty|setSoundProperty]] - [[StartSound|startSound]] - [[StopSound|stopSound]]
|}

← Older revision		Revision as of 11:37, 19 May 2023
Line 1:		Line 1:
−	~~==toggleSoundPause==~~	+	#REDIRECT [[Global Command: toggleSoundPause]]
−
−	~~<div class="command-min-version-info">Available since: <span class="command-min-version">v4.0</span></div>~~
−
−	~~<div class="command-doc">Pause/resume the specified sound.</div>~~
−
−	~~Lua Syntax:~~
−	~~<pre class="command-syntax">toggleSoundPause(soundID)</pre>~~
−	~~===Arguments===~~
−	~~====soundID====~~
−	~~:'''int''' - ID of sound which should be paused/resumed.~~
−	~~===Flags===~~
−	~~===Return Values===~~
−	~~;status~~
−	~~:True if sound was successfully paused/resumed, false otherwise.~~
−	~~===Examples===~~
−	~~Example 1:~~
−	~~<syntaxhighlight>~~
−	~~local soundID = getSoundId('vispath~~:~~sounds/example.ogg')~~
−	toggleSoundPause~~(soundID)~~
−	~~</syntaxhighlight>~~

@@ Line 1: / Line 1: @@
 ==toggleSoundPause==
-<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">Pause/resume the specified sound.</div>
@@ Line 20: / Line 20: @@
 toggleSoundPause(soundID)
 </syntaxhighlight>

← Older revision		Revision as of 13:57, 26 November 2013
Line 20:		Line 20:
	toggleSoundPause(soundID)		toggleSoundPause(soundID)
	</syntaxhighlight>		</syntaxhighlight>
		+	[[Category:Player Commands]]

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+==toggleSoundPause==
-Allows you to toggle between pause & resume of an active linked sound!
+<div class="command-doc">Pause/resume the specified sound.</div>
+Lua Syntax:
-Syntax:
+<pre class="command-syntax">toggleSoundPause(soundID)</pre>
 <syntaxhighlight>
-toggleSoundPause(id)
+local soundID = getSoundId('vispath:sounds/example.ogg')
 toggleSoundPause(soundID)
 </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>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 29: / Line 29: @@
-<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>
 none
-<b><u>Return</u></b>
+<span class="bold underline>Return</span>
-<b>success</b> <br/>
+<span class="bold">success</span> <br/>
 Returns true or false boolean value depending on if the linked sound was successfully paused or resumed!
 {{i18n|ToggleSoundPause}} <br/>
-{| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
+{| class="tbl-ds"
 |-
-|<b>Relevant Pages</b>: [[GetSoundId|getSoundId]] - [[GetSoundProperty|getSoundProperty]] - [[SetSoundProperty|setSoundProperty]] - [[StartSound|startSound]] - [[StopSound|stopSound]]
+|<span class="bold">Relevant Pages</span>: [[GetSoundId|getSoundId]] - [[GetSoundProperty|getSoundProperty]] - [[SetSoundProperty|setSoundProperty]] - [[StartSound|startSound]] - [[StopSound|stopSound]]
 |}