Global Command: getVolume - Revision history

EK: EK moved page GetVolume (CMS) to Global Command: getVolume

2023-05-04T20:28:52Z

EK moved page GetVolume (CMS) to Global Command: getVolume

EK at 20:27, 4 May 2023

2023-05-04T20:27:20Z

AFRLme at 14:56, 23 March 2014

2014-03-23T14:56:21Z

AFRLme at 14:55, 23 March 2014

2014-03-23T14:55:31Z

AFRLme at 14:54, 23 March 2014

2014-03-23T14:54:27Z

AFRLme at 14:52, 23 March 2014

2014-03-23T14:52:57Z

AFRLme: Created page with "
Function History

Available since..."

2014-03-23T14:48:38Z

Created page with "<div class="toccolours mw-collapsible mw-collapsed tbl-ds"> <span class="bold">Function History</span> <div class="mw-collapsible-content"> <div class="alt-bg">Available since..."

New page

<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
<span class="bold">Function History</span>
<div class="mw-collapsible-content">
<div class="alt-bg">Available since v3.0</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 tbl-ds">
<span class="bold">Additional Info</span>
<div class="mw-collapsible-content">
<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>

Syntax:
<syntaxhighlight>
getVolume(type)
</syntaxhighlight>

Example:
<syntaxhighlight>
-- is music volume over 50%?
if getVolume(eMusicVolume) > 50 then
-- do some action!
end

-- is sound fx volume less than 25%?
if getVolume(eSoundVolume) < 25 then
-- do some action!
end

-- is speech volume more than or equal to 80%?
if getVolume(eSpeechVolume) >= 80 then
-- do some action!
end

-- is movie volume at 50%?
if getVolume(eMovieVolume) == 50 then
-- do some action!
end

-- is global (master) volume not equal to 50%?
if getVolume(eGlobalVolume) ~= 50 then
-- do some action!
end
</syntaxhighlight>

<span class="bold underline">Arguments</span>

<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)

<span class="bold underline">Flags</span>

none

<span class="bold underline">Return</span>

<span class="bold">volume</span> <br/>
The queried volume

{| class="tbl-ds"
|-
|<span class="bold">Relevant Pages</span>: [[SetVolume|setVolume]]
|}

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+Retrieve the general volume levels for music, sound, speech, videos, and master.
+{| class="ts"
-Allows the user to check current volume levels of: music, sound, speech, video, & master.
+|-
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+| style="width:15%" | Related functions
-<span class="bold">Additional Info</span>
+| [[Global Command: setVolume|setVolume]]
-<div class="mw-collapsible-content">
+|}
-Syntax:
+== Syntax ==
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
 getVolume(type)
 </syntaxhighlight>
-Example 1: recommended getVolume() method
+== Parameters ==
--- is speech volume more than or equal to 80%?
+{| class="ts"
-if getVolume(eSpeechVolume) >= 80 then
+|-
- -- do some action!
+! style="width:15%" | Parameter
-end
+! style="width:10%" | Type
--- is global (master) volume not equal to 50%?
+''The available types are members of the [https://www.visionaire-studio.com/luadocs/lua.html#sound-volume-types sound volume enumeration]. The parameter can be passed as name (e.&nbsp;g. eMusicVolume), or number (e.&nbsp;g. 0), see the examples.''
-if getVolume(eGlobalVolume) ~= 50 then
+|-
- -- do some action!
+| eSoundVolume (1)
-end
+|-
-</syntaxhighlight>
+| eSpeechVolume (2)
-Example 2: using integer values instead
+|-
-<syntaxhighlight>
+| eMovieVolume (3)
-getVolume(0) -- is the same as...
+|-
-getVolume(eMusicVolume)
+| eGlobalVolume (4)
-</syntaxhighlight>
+|}
-<span class="bold underline">Arguments</span>
+{| class="ts"
-<span class="bold underline">Flags</span>
+'''Example 1:''' Enable the text output, if the speech volume level is below 30.
-none
+-- You can also pass the volume type as an integer. The following code will do the same.
+if getVolume(2) < 30 then
+  game.TextOutput = eTextAndSpeechOutput
-<span class="bold underline">Return</span>
+end
+</syntaxhighlight>
-<span class="bold">volume</span> <br/>
+{{toc}}

@@ Line 51: / Line 51: @@
 Example 2: using integer values instead
 <syntaxhighlight>
-getVolume(0) --[[ is the same as ]]-- getVolume(eMusicVolume)
+getVolume(0) -- is the same as...
 </syntaxhighlight>
@@ Line 71: / Line 72: @@
 <span class="bold">volume</span> <br/>
 The queried volume

← Older revision	Revision as of 20:28, 4 May 2023
(No difference)

@@ Line 77: / Line 77: @@
 {| class="tbl-ds"
 |-
-|<span class="bold">Relevant Pages</span>: [[SetVolume|setVolume]]
+|<span class="bold">Relevant Pages</span>: [[SetVolume_(CMS)|setVolume]]
 |}

@@ Line 7: / Line 7: @@
-Allows the user to check current volume levels of: music, sound fx, speech, movies & global(master)
+Allows the user to check current volume levels of: music, sound, speech, video, & master.
 <div class="toccolours mw-collapsible mw-collapsed tbl-ds">
 <span class="bold">Additional Info</span>
 <div class="mw-collapsible-content">
-<div>These are the names or 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>
+<pre>eMusicVolume(0), eSoundVolume(1), eSpeechVolume(2), eMovieVolume(3), or eGlobalVolume(4)</pre></div>
 </div></div>
@@ Line 22: / Line 22: @@
-Example:
+Example 1: recommended getVolume() method
 <syntaxhighlight>
 -- is music volume over 50%?
@@ Line 48: / Line 48: @@
   -- do some action!
 end
 </syntaxhighlight>