isGamePaused

From Bohemia Interactive Community
Revision as of 15:47, 8 November 2023 by Lou Montana (talk | contribs) (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *R([a-z ])" to "$1 - r$2")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Hover & click on the images for description

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

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

Examples

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

Additional Information

See also:
isGameFocused

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