Difference between revisions of "Screen:getState"
From GiderosMobile
| Line 1: | Line 1: | ||
__NOTOC__  | __NOTOC__  | ||
| − | + | '''Available since:''' Gideros 2017.8<br/>  | |
| − | '''  | + | '''Class:''' [[Screen]]<br/>  | 
| − | '''  | + | |
| − | ===   | + | === Description ===  | 
| − | + | Returns the state of the screen.  | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<source lang="lua">  | <source lang="lua">  | ||
(number) = Screen:getState()  | (number) = Screen:getState()  | ||
</source>  | </source>  | ||
| − | ===   | + | |
| − | '''  | + | The returned number is the sum of the following possible values:  | 
| + | * Screen.STATE_MINIMIZED: Screen/Window is minimized  | ||
| + | * Screen.STATE_MAXIMIZED: Screen/Window is maximized  | ||
| + | * Screen.STATE_FULLSCREEN: Screen/Window is fullscreen  | ||
| + | * Screen.STATE_ACTIVE: Screen/Window is active/focused  | ||
| + | * Screen.STATE_HIDDEN: Screen/Window is not displayed  | ||
| + | * Screen.STATE_CLOSED: Screen/Window is closed  | ||
| + | |||
| + | === Return values ===  | ||
| + | '''Returns''' (number) the screen state<br/>  | ||
{{Screen}}  | {{Screen}}  | ||
Revision as of 03:12, 28 April 2021
Available since: Gideros 2017.8
Class: Screen
Description
Returns the state of the screen.
(number) = Screen:getState()
The returned number is the sum of the following possible values:
- Screen.STATE_MINIMIZED: Screen/Window is minimized
 - Screen.STATE_MAXIMIZED: Screen/Window is maximized
 - Screen.STATE_FULLSCREEN: Screen/Window is fullscreen
 - Screen.STATE_ACTIVE: Screen/Window is active/focused
 - Screen.STATE_HIDDEN: Screen/Window is not displayed
 - Screen.STATE_CLOSED: Screen/Window is closed
 
Return values
Returns (number) the screen state