Difference between revisions of "GetVolume"
From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 1: | Line 1: | ||
− | <div class="toccolours mw-collapsible mw-collapsed" | + | <div class="toccolours mw-collapsible mw-collapsed tbl-ds"> |
− | + | <span class="bold">Command History</span> | |
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
− | <div | + | <div class="alt-bg">Available since v3.7</div> |
− | <div>MovieVolume & GlobalVolume added to | + | <div>MovieVolume & GlobalVolume added to v3.8</div> |
</div></div> | </div></div> | ||
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 fx, speech, movies & global(master) | ||
− | <div class="toccolours mw-collapsible mw-collapsed" | + | <div class="toccolours mw-collapsible mw-collapsed tbl-ds"> |
− | + | <span class="bold">Additional Info</span> | |
<div class="mw-collapsible-content"> | <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 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> | </div></div> | ||
Line 52: | Line 52: | ||
− | < | + | <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) | + | The type of volume to return: eMusicVolume(0), eSoundVolume(1), eSpeechVolume(2), eMovieVolume(3) or eGlobalVolume(4) |
− | < | + | <span class="bold underline">Flags</span> |
none | none | ||
− | < | + | <span class="bold underline">Return</span> |
− | < | + | <span class="bold">volume</span> <br/> |
The queried volume | The queried volume | ||
{{i18n|GetVolume}} <br/> | {{i18n|GetVolume}} <br/> | ||
− | {| | + | {| class="tbl-ds" |
|- | |- | ||
− | |< | + | |<span class="bold">Relevant Pages</span>: [[SetVolume|setVolume]] |
|} | |} |
Revision as of 01:28, 31 March 2013
Command History
Available since v3.7
MovieVolume & GlobalVolume added to v3.8
Allows the user to check current volume levels of: music, sound fx, speech, movies & global(master)
Additional Info
These are the numbers used inside of the getVolume(brackets) to check specific volume types!
eMusicVolume(0), eSoundVolume(1), eSpeechVolume(2), eMovieVolume(3) or eGlobalVolume(4)
Syntax:
getVolume(type)
Example:
-- 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
Arguments
type: integer (number)
The type of volume to return: eMusicVolume(0), eSoundVolume(1), eSpeechVolume(2), eMovieVolume(3) or eGlobalVolume(4)
Flags
none
Return
volume
The queried volume
日本語 – 正體中文 – 한국어 – Dansk – Deutsch – English – Español – Français – Italiano – Nederlands – Polski – Português – Svenska – Русский |
Relevant Pages: setVolume |