Difference between revisions of "Screen:getState"

Latest revision as of 15:32, 13 July 2023

Available since: Gideros 2017.8
Class: Screen

Returns the state of the screen.

(number) = Screen:getState()

The returned number is the sum of the following possible values:

Returns (number) the sum of the screen states

@@ Line 1: / Line 1: @@
 __NOTOC__
 '''Available since:''' Gideros 2017.8<br/>
+'''Class:''' [[Screen]]<br/>
 === Description ===
-Return the state of the screen. The returned number is the or-sum of the following possible values:
+Returns the state of the screen.
-   	* Screen.STATE_MINIMIZED: Screen/Window is minimized.
+<syntaxhighlight lang="lua">
-   	* 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.
-<source lang="lua">
 (number) = Screen:getState()
-</source>
+</syntaxhighlight>
+The returned number is the sum of the following possible values:
+* Screen.STATE_NORMAL '''0''': Screen/Window is normal
+* Screen.STATE_MINIMIZED '''1''': Screen/Window is minimized
+* Screen.STATE_MAXIMIZED '''2''': Screen/Window is maximized
+* Screen.STATE_FULLSCREEN '''4''': Screen/Window is fullscreen
+* Screen.STATE_ACTIVE '''8''': Screen/Window is active/focused
+* Screen.STATE_HIDDEN '''16''': Screen/Window is not displayed
+* Screen.STATE_CLOSED '''32''': Screen/Window is closed
 === Return values ===
-'''Returns''' (number) The Screen's state<br/>
+'''Returns''' (number) the sum of the screen states<br/>
+{{Screen}}