isGamePaused

From Bohemia Interactive Community
Jump to navigation Jump to search
Introduced with Arma 3 Development Branch version 1.95
  

Click on the images for descriptions

Introduced in

Game:
Arma 3 Development Branch
Version:
1.95

Description

Description:
Returns true if the game simulation is paused due to some system event like a dialog or pause menu or when user has Alt+Tab-ed (except when -nopause start up param is used). Relevant to SP, in MP simulation does not get paused.

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

Syntax:
isGamePaused
Return Value:
Boolean

Examples

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

Additional Information

Multiplayer:
-
See also:
isGameFocusedisUIContextcanSuspendisRemoteExecutedisRemoteExecutedJIPserverCommand

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section