Difference between revisions of "Global Command: getWindowBrightness"

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...")
 
m
(3 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
</div></div>
 
</div></div>
  
Returns the integer value of global window brightness; min = 0, max = 100.
+
 
 +
Returns the integer value of global window brightness. (min = 0, max = 100)
 +
 
  
 
Syntax:
 
Syntax:
Line 15: Line 17:
 
Example:
 
Example:
 
<syntaxhighlight>
 
<syntaxhighlight>
 +
-- check if brightness value is less than 50%?
 
if getWindowBrightness() < 50 then
 
if getWindowBrightness() < 50 then
 
  -- do something...
 
  -- do something...
Line 32: Line 35:
 
<span class="bold underline">Return</span><br/>
 
<span class="bold underline">Return</span><br/>
 
'''brightness''' <br/>
 
'''brightness''' <br/>
The integer value of window brightness.
+
The integer value of global window brightness.
  
  
Line 38: Line 41:
 
{| class="tbl-ds"
 
{| class="tbl-ds"
 
|-
 
|-
|<span class="bold">Relevant Pages</span>: [[SetWindowBrightness_(CMS)|setVolume]]
+
|<span class="bold">Relevant Pages</span>: [[SetWindowBrightness_(CMS)|setWindowBrightness]]
 
|}
 
|}

Revision as of 17:12, 23 March 2014

Function History

Available since v3.8


Returns the integer value of global window brightness. (min = 0, max = 100)


Syntax:

getWindowBrightness()


Example:

-- check if brightness value is less than 50%?
if getWindowBrightness() < 50 then
 -- do something...
end


Arguments
none


Flags
none


Return
brightness
The integer value of global window brightness.


Relevant Pages: setWindowBrightness