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" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
 
<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
<b>History</b>: Available since <span style="color:green">v3.7</span>
+
<b>Command History</b>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
MovieVolume & GlobalVolume added to <span style="color:green">v3.8</span>
+
<div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.7</span></div>
 +
<div>MovieVolume & GlobalVolume added to <span style="color:green">v3.8</span></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)
{| class="mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
+
<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
! Additional Info
+
<b>Additional Info</b>
|-
+
<div class="mw-collapsible-content">
|
+
<div>These are the numbers used inside of the getVolume(brackets) to check specific volume types! <br/>
These are the numbers used inside of the getVolume(brackets) to check specific volume types! <br/>
+
  eMusicVolume (0), eSoundVolume (1), eSpeechVolume (2), eMovieVolume (3) or eGlobalVolume (4)</div>
  eMusicVolume (0), eSoundVolume (1), eSpeechVolume (2), eMovieVolume (3) or eGlobalVolume (4)
+
</div></div>
|}
+
 
  
 
Syntax:
 
Syntax:
Line 17: Line 20:
 
getVolume()
 
getVolume()
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
  
 
Example:
 
Example:
Line 45: Line 49:
 
end
 
end
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
  
  

Revision as of 18:38, 7 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()


Example:

-- is music volume over 50%?
if getVolume(0) > 50 then
 -- do some action!
end

-- is sound fx volume less than 25%?
if getVolume(1) < 25 then
 -- do some action!
end

-- is speech volume more than or equal to 80%?
if getVolume(2) >= 80 then
 -- do some action!
end

-- is movie volume at 50%?
if getVolume(3) == 50 then
 -- do some action!
end

-- is global (master) volume not equal to 50%?
if getVolume(4) ~= 50 then
 -- do some action!
end


Arguments

type: integer
The type of volume to return: eMusicVolume (0), eSoundVolume (1), eSpeechVolume (2), eMovieVolume (3) or eGlobalVolume (4)

Flags: none

Return: volume
The queried volume