GetVolume - Revision history

EK: Redirected page to Global Command: getVolume

2023-05-19T11:26:18Z

Redirected page to Global Command: getVolume

Vis apiuser at 20:27, 30 September 2014

2014-09-30T20:27:53Z

Vis apiuser at 13:56, 26 November 2013

2013-11-26T13:56:41Z

Vis apiuser at 16:12, 22 November 2013

2013-11-22T16:12:00Z

AFRLme at 00:32, 31 March 2013

2013-03-31T00:32:40Z

AFRLme at 00:29, 31 March 2013

2013-03-31T00:29:51Z

AFRLme at 00:28, 31 March 2013

2013-03-31T00:28:43Z

AFRLme at 17:12, 30 March 2013

2013-03-30T17:12:45Z

AFRLme at 13:49, 12 March 2013

2013-03-12T13:49:02Z

AFRLme at 13:48, 12 March 2013

2013-03-12T13:48:31Z

← Older revision		Revision as of 11:26, 19 May 2023
Line 1:		Line 1:
−	~~==getVolume==~~	+	#REDIRECT [[Global Command: getVolume]]
−
−	~~<div class="command-min-version-info">Available since: <span class="command-min-version">v3.0</span></div>~~
−
−	~~<div class="command-doc">Returns the general volume for background music, sound or speech output.</div>~~
−
−	~~Lua Syntax:~~
−	~~<pre class="command-syntax">getVolume(type)</pre>~~
−	~~===Arguments===~~
−	~~====type====~~
−	~~:'''int''' - The type of volume to return: eMusicVolume (0), eSoundVolume (1), eSpeechVolume (2), eMovieVolume (3) or eGlobalVolume (4).~~
−	~~===Flags===~~
−	~~===Return Values===~~
−	~~;volume~~
−	~~:The queried volume.~~
−	~~===Examples===~~
−	~~Example 1:~~
−	~~<syntaxhighlight>~~
−	~~-- is music volume over 50%?~~
−	~~if getVolume(eMusicVolume) > 50 then~~
−	~~-- do some action~~
−	~~end~~
−	~~</syntaxhighlight>~~
−	~~Example 2:~~
−	~~<syntaxhighlight>~~
−	~~-- is speech volume more than or equal to 80%?~~
−	~~if getVolume(eSpeechVolume) >= 80 then~~
−	~~-- do some action~~
−	~~end~~
−	~~</syntaxhighlight>~~
−	~~Example 3~~:
−	~~<syntaxhighlight>~~
−	~~-- is global (master) volume not equal to 50%?~~
−	if getVolume~~(eGlobalVolume) ~= 50 then~~
−	~~-- do some action~~
−	~~end~~
−	~~</syntaxhighlight>~~

← Older revision		Revision as of 20:27, 30 September 2014
Line 36:		Line 36:
	end		end
	</syntaxhighlight>		</syntaxhighlight>
−	~~[[Category:Player Commands]]~~

← Older revision		Revision as of 13:56, 26 November 2013
Line 36:		Line 36:
	end		end
	</syntaxhighlight>		</syntaxhighlight>
		+	[[Category:Player Commands]]

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+==getVolume==
-Allows the user to check current volume levels of: music, sound fx, speech, movies & global(master)
+<div class="command-doc">Returns the general volume for background music, sound or speech output.</div>
+Lua Syntax:
-Syntax:
+<pre class="command-syntax">getVolume(type)</pre>
-<syntaxhighlight>
+===Arguments===
-getVolume(type)
+====type====
-</syntaxhighlight>
+:'''int''' - The type of volume to return: eMusicVolume (0), eSoundVolume (1), eSpeechVolume (2), eMovieVolume (3) or eGlobalVolume (4).
+===Flags===
+===Return Values===
-Example:
+;volume
 <syntaxhighlight>
 -- is music volume over 50%?
 if getVolume(eMusicVolume) > 50 then
- -- do some action!
+-- do some action
 end
+</syntaxhighlight>
--- is sound fx volume less than 25%?
+Example 2:
-if getVolume(eSoundVolume) < 25 then
+<syntaxhighlight>
 -- is speech volume more than or equal to 80%?
 if getVolume(eSpeechVolume) >= 80 then
- -- do some action!
+-- do some action
 end
+</syntaxhighlight>
--- is movie volume at 50%?
+Example 3:
-if getVolume(eMovieVolume) == 50 then
+<syntaxhighlight>
 -- is global (master) volume not equal to 50%?
 if getVolume(eGlobalVolume) ~= 50 then
- -- do some action!
+-- do some action
 end
 </syntaxhighlight>

@@ Line 54: / Line 54: @@
 <span class="bold underline">Arguments</span>
-<span class="bold underline">type</span>: integer (number) <br/>
+<span class="bold">type</span>: integer (number) <br/>
 The type of volume to return: eMusicVolume(0), eSoundVolume(1), eSpeechVolume(2), eMovieVolume(3) or eGlobalVolume(4)

@@ Line 11: / Line 11: @@
 <span class="bold">Additional Info</span>
 <div class="mw-collapsible-content">
-<div>These are the numbers used inside of the getVolume(brackets) to check specific volume types! <br/>
+<div>These are the names or numbers used inside of the getVolume(brackets) to check specific volume types! <br/>
 <pre>eMusicVolume(0), eSoundVolume(1), eSpeechVolume(2), eMovieVolume(3) or eGlobalVolume(4)</pre></div>
 </div></div>

@@ 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.7</span></div>
+<div class="alt-bg">Available since v3.7</div>
-<div>MovieVolume & GlobalVolume added to <span style="color:orange">v3.8</span></div>
+<div>MovieVolume & GlobalVolume added to v3.8</div>
 </div></div>
 Allows the user to check current volume levels of: music, sound fx, speech, movies & global(master)
-<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>These are the numbers used inside of the getVolume(brackets) to check specific volume types! <br/>
-<pre>eMusicVolume (0), eSoundVolume (1), eSpeechVolume (2), eMovieVolume (3) or eGlobalVolume (4)</pre></div>
+<pre>eMusicVolume(0), eSoundVolume(1), eSpeechVolume(2), eMovieVolume(3) or eGlobalVolume(4)</pre></div>
 </div></div>
@@ Line 52: / Line 52: @@
-<b><u>Arguments</u></b>
+<span class="bold underline">Arguments</span>
-<b>type</b>: integer (number) <br/>
+<span class="bold underline">type</span>: integer (number) <br/>
-The type of volume to return: eMusicVolume (0), eSoundVolume (1), eSpeechVolume (2), eMovieVolume (3) or eGlobalVolume (4)
+The type of volume to return: eMusicVolume(0), eSoundVolume(1), eSpeechVolume(2), eMovieVolume(3) or eGlobalVolume(4)
-<b><u>Flags</u></b>
+<span class="bold underline">Flags</span>
 none
-<b><u>Return</u></b>
+<span class="bold underline">Return</span>
-<b>volume</b> <br/>
+<span class="bold">volume</span> <br/>
 The queried volume
 {{i18n|GetVolume}} <br/>
-{| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
+{| class="tbl-ds"
 |-
-|<b>Relevant Pages</b>: [[SetVolume|setVolume]]
+|<span class="bold">Relevant Pages</span>: [[SetVolume|setVolume]]
 |}