Global Command: setVolume - Revision history

EK: EK moved page SetVolume (CMS) to Global Command: setVolume

2023-05-04T20:37:19Z

EK moved page SetVolume (CMS) to Global Command: setVolume

EK at 20:37, 4 May 2023

2023-05-04T20:37:09Z

AFRLme: Created page with "
Function History

Available since..."

2014-03-23T15:22:47Z

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 set volume levels of: music, sound fx, 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 numbers used inside of the setVolume(''brackets'') to set specific volume types. <br/>
<pre>eMusicVolume(0), eSoundVolume(1), eSpeechVolume(2), eMovieVolume(3) or eGlobalVolume(4)</pre></div>
</div></div>

Syntax:
<syntaxhighlight>
setVolume(type, volume)
</syntaxhighlight>

Example 1: recommended method
<syntaxhighlight>
-- set music volume to 50%!
setVolume(eMusicVolume, 50)

-- set sound fx volume to 50%!
setVolume(eSoundVolume, 50)

-- set speech volume to 50%!
setVolume(eSpeechVolume, 50)

-- set movie volume to 50%!
setVolume(eMovieVolume, 50)

-- set global (master) volume to 50%!
setVolume(eGlobalVolume, 50)
</syntaxhighlight>
Example 2: using integer values instead
<syntaxhighlight>
setVolume(0, 50) -- is the same as...
setVolume(eMusicVolume, 50)
</syntaxhighlight>

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

<span class="bold">type</span>: integer (number) <br/>
The type of volume to set: eMusicVolume(0), eSoundVolume(1), eSpeechVolume(2), eMovieVolume(3) or eGlobalVolume(4)

<span class="bold">volume</span>: integer (number) <br/>
New value for volume. Must be a value between 0 and 100

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

none

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

none

{| class="tbl-ds"
|-
|<span class="bold">Relevant Pages</span>: [[GetVolume_(CMS)|getVolume]]
|}

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

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+Set the general volume levels for music, sound, speech, videos, and master.
+{| class="ts"
-Allows the user to set volume levels of: music, sound fx, 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: getVolume|getVolume]]
-<div class="mw-collapsible-content">
+|}
-Syntax:
+== Syntax ==
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
 setVolume(type, volume)
 </syntaxhighlight>
-Example 1: recommended method
+== Parameters ==
--- set sound fx volume to 50%!
+{| class="ts"
-setVolume(eSoundVolume, 50)
+|-
--- set movie volume 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.''
-setVolume(eMovieVolume, 50)
+|-
+== Return values ==
 none
-<span class="bold underline">Return</span>
+== Examples ==
-none
+'''Example 1:''' Set the speech volume level to 80.
+-- You can also pass the volume type as an integer. The following code will do the same.
+setVolume(2, 80)
-{| class="tbl-ds"
+</syntaxhighlight>
-|-
+{{toc}}

Global Command: setVolume - Revision history

EK: EK moved page SetVolume (CMS) to Global Command: setVolume

EK at 20:37, 4 May 2023

AFRLme: Created page with " Function History Available since..."

AFRLme: Created page with "
Function History

Available since..."