isGamePaused: Difference between revisions

Revision as of 15:15, 3 May 2022

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

: 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 6: / Line 6: @@
 |gr1= System
-|descr= Returns the state of game simulation. Simulation can get paused by pressing {{Controls|ALT|TAB}} or a system dialog opening (e.g. {{Controls|ESC}} menu). Simulation will not get paused if {{hl|-noPause}} [[Arma 3: Startup Parameters|startup parameter]] is used.
+|descr= Returns the state of game simulation. Simulation can get paused by pressing {{Controls|ALT|TAB}} or a system dialog opening (e.g. {{Controls|ESC}} menu).
-{{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.}}
+Simulation will not get paused if {{hl|-noPause}} [[Arma 3: Startup Parameters|startup parameter]] is used.
+{{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]].
@@ Line 15: / Line 16: @@
 |r1= [[Boolean]] - Returns [[true]] if game simulation is paused, [[false]] if not
-|x1= <code>[[onEachFrame]]
+|x1= <sqf>
+onEachFrame
 {
-	[[if]] ([[isGamePaused]]) [[exitWith]] {};
+	if (isGamePaused) exitWith {};
-	{{cc|...do stuff}}
+	// ...do stuff
-};</code>
+};
+</sqf>
 |seealso= [[isGameFocused]]
 }}