isGamePaused

Arma 3 v1.96

Command · Markdown · JSON · original wiki page

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.

Note
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.

Syntax

isGamePaused

Returns: Boolean - returns true if game simulation is paused, false if not

Examples

Example 1

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

Multiplayer

In multiplayer the simulation will not get paused and this command will always return false.