isGamePaused: Difference between revisions

Revision as of 23:46, 15 November 2021

Hover & click on the images for description

Description:: Returns the state of game simulation. Simulation can get paused by pressing ALT + ↹ Tab or a system dialog opening (e.g. ESC menu). Simulation will not get paused if -noPause startup parameter is used.
ⓘ
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.
Multiplayer:: In multiplayer the simulation will not get paused and this command will always return false.
Groups:: System

Syntax:: isGamePaused
Return Value:: Boolean - Returns true if game simulation is paused, false if not

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

: 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

@@ Line 7: / Line 7: @@
 |descr= Returns the state of game simulation. Simulation can get paused by pressing {{KeyboardShortcut|ALT|TAB}} or a system dialog opening (e.g. {{KeyboardShortcut|ESC}} menu). Simulation will not get paused if <tt>-noPause</tt> [[Arma 3: Startup Parameters|startup parameter]] is used.
-{{Feature|Informative|[[onEachFrame]] event and <tt>"EachFrame"</tt> event handler continue to execute when the simulation is paused, which could result in undesired backlog. Use [[isGamePaused]] to skip loop if needed.}}
+{{Feature|Informative|[[onEachFrame]] event and {{hl|"EachFrame"}} event handler continue to execute when the simulation is paused, which could result in undesired backlog. Use [[isGamePaused]] to skip loop if needed.}}
 |mp= In multiplayer the simulation will not get paused and this command will always return [[false]].