|
|
| (4 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| − | <div class="toccolours mw-collapsible mw-collapsed tbl-ds">
| + | #REDIRECT [[Global Command: getVolume]] |
| − | <span class="bold">Command History</span>
| |
| − | <div class="mw-collapsible-content">
| |
| − | <div class="alt-bg">Available since v3.7</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 underline">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
| |
| − | {{i18n|GetVolume}} <br/>
| |
| − | {| class="tbl-ds"
| |
| − | |-
| |
| − | |<span class="bold">Relevant Pages</span>: [[SetVolume|setVolume]]
| |
| − | |}
| |
