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