isGamePaused

From Bohemia Interactive Community
Revision as of 16:53, 3 May 2021 by Lou Montana (talk | contribs) (Text replacement - "\|game([0-9]) ?= (.+) \|version([0-9]) ?= (.+) " to "|game$1= $2 |version$3= $4 ")
Jump to navigation Jump to search
Arma 3 logo black.png1.96
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
Retrieved from "https://community.bistudio.com/wiki?title=isGamePaused&oldid=257100"