View source for Global Command: getWindowMode

Returns the current window mode, i.&nbsp;e. if the game is running at fullscreen or in a window.

{| class="ts"
|-
| style="width:15%" | Related functions
| [[Global Command: toggleWindowMode|toggleWindowMode]]
|}


== Syntax ==
<syntaxhighlight lang="lua">
getWindowMode()
</syntaxhighlight>


== Parameters ==

none


== Return values ==
{| class="ts"
|-
! style="width:15%" | Type
! Description
|-
| boolean
| True if the game is running at fullscreen, false if it is running in a window.
|}


== Examples ==

'''Example 1:''' Toggle the window mode, if the game is running at fullscreen, thus make it run in a window.
<syntaxhighlight lang ="lua">
if getWindowMode() then
  toggleWindowMode()
end
</syntaxhighlight>
{{toc}}