Difference between revisions of "Application:setKeepAwake"

From GiderosMobile
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
'''Available since:''' Gideros 2011.6<br/>
+
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
=== Description ===
+
=== <translate>Description</translate> ===
 
<translate><br />
 
<translate><br />
 
Controls the screen dimming and device sleeping of the device. When the application has no touches as user input for some period,<br />
 
Controls the screen dimming and device sleeping of the device. When the application has no touches as user input for some period,<br />
Line 15: Line 15:
 
  Application:setKeepAwake(keepAwake)
 
  Application:setKeepAwake(keepAwake)
 
</source>
 
</source>
=== Parameters ===
+
=== <translate>Parameters</translate> ===
 
'''keepAwake''': (boolean) <translate>if true, screen is kept awake.</translate> <br/>
 
'''keepAwake''': (boolean) <translate>if true, screen is kept awake.</translate> <br/>
=== Examples ===
+
=== <translate>Examples</translate> ===
 
'''Example'''<br/>
 
'''Example'''<br/>
 
<source lang="lua">application:setKeepAwake(true) -- disable screen dimming and device sleeping
 
<source lang="lua">application:setKeepAwake(true) -- disable screen dimming and device sleeping
 
application:setKeepAwake(false) -- enable screen dimming and device sleeping</source>
 
application:setKeepAwake(false) -- enable screen dimming and device sleeping</source>

Revision as of 08:29, 24 August 2018

Available since: Gideros 2011.6

Description


Controls the screen dimming and device sleeping of the device. When the application has no touches as user input for some period,
the system puts the device into a sleep state where the screen dims. However some applications have no input and controlled
by accelerometer or gyroscope only. For these kind applications, the screen should be kept awake by calling this function
with parameter true.

<ul>
<li>*Note:** This function has no effect on desktop.</li>
</ul>

 Application:setKeepAwake(keepAwake)

Parameters

keepAwake: (boolean) if true, screen is kept awake.

Examples

Example

application:setKeepAwake(true)	-- disable screen dimming and device sleeping
application:setKeepAwake(false)	-- enable screen dimming and device sleeping