Difference between revisions of "Global Command: getVolume"
From The Official Visionaire Studio: Adventure Game Engine Wiki
(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...") |
|||
| Line 7: | Line 7: | ||
| − | Allows the user to check current volume levels of: music, sound | + | Allows the user to check current volume levels of: music, sound, speech, video, & master. |
<div class="toccolours mw-collapsible mw-collapsed tbl-ds"> | <div class="toccolours mw-collapsible mw-collapsed tbl-ds"> | ||
<span class="bold">Additional Info</span> | <span class="bold">Additional Info</span> | ||
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
| − | <div>These are the names or numbers used inside of the getVolume(brackets) to check specific volume types | + | <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> | </div></div> | ||
| Line 22: | Line 22: | ||
| − | Example: | + | Example 1: recommended getVolume() method |
<syntaxhighlight> | <syntaxhighlight> | ||
-- is music volume over 50%? | -- is music volume over 50%? | ||
| Line 48: | Line 48: | ||
-- do some action! | -- do some action! | ||
end | end | ||
| + | </syntaxhighlight> | ||
| + | Example 2: using integer values instead | ||
| + | <syntaxhighlight> | ||
| + | getVolume(eMusicVolume) | ||
| + | -- is the same as... | ||
| + | getVolume(0) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 15:52, 23 March 2014
Function History
Available since v3.0
MovieVolume & GlobalVolume added to v3.8
Allows the user to check current volume levels of: music, sound, speech, video, & master.
Additional Info
These are the names or 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 1: recommended getVolume() method
-- 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!
endExample 2: using integer values instead
getVolume(eMusicVolume)
-- is the same as...
getVolume(0)
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
| Relevant Pages: setVolume |
