isGamePaused

From Bohemia Interactive Community
Revision as of 10:54, 18 January 2021 by Lou Montana (talk | contribs) (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects? in MP|M...)
Jump to navigation Jump to search
Arma 3 logo black.png1.96
Hover & click on the images for description

Description

Description:
Returns true if the game simulation is paused due to some system event like a dialog or pause menu or when user has Alt+Tab-ed (except when -nopause start up param is used). Relevant to SP, in MP simulation does not get paused.

ⓘ
onEachFrame event and "EachFrame" event handler continue to execute when the simulation is paused, which could result in undesired backlog. Use isGamePaused to skip loop if needed.
Groups:
System

Syntax

Syntax:
isGamePaused
Return Value:
Boolean

Examples

Example 1:
onEachFrame { if (isGamePaused) exitWith {}; // ...do stuff };

Additional Information

See also:
isGameFocusedisUIContextcanSuspendisRemoteExecutedisRemoteExecutedJIPserverCommand

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Retrieved from "https://community.bistudio.com/wiki?title=isGamePaused&oldid=210318"