isGamePaused: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...) |
||
| Line 1: | Line 1: | ||
{{Command | {{Command | ||
| arma3 | | arma3 | ||
|1.96 | |1.96 | ||
|gr1= System | |gr1= System | ||
| 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. | | 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. | ||
<br><br>{{Informative | [[onEachFrame]] event and <tt>"EachFrame"</tt> event handler continue to execute when the simulation is paused, which could result in undesired backlog. Use [[isGamePaused]] to skip loop if needed. }} | <br><br>{{Informative | [[onEachFrame]] event and <tt>"EachFrame"</tt> event handler continue to execute when the simulation is paused, which could result in undesired backlog. Use [[isGamePaused]] to skip loop if needed. }} | ||
| [[isGamePaused]] | | [[isGamePaused]] | ||
| [[Boolean]] | | [[Boolean]] | ||
|x1= <code>[[onEachFrame]] | |x1= <code>[[onEachFrame]] | ||
| Line 18: | Line 18: | ||
[[if]] ([[isGamePaused]]) [[exitWith]] {}; | [[if]] ([[isGamePaused]]) [[exitWith]] {}; | ||
{{cc|...do stuff}} | {{cc|...do stuff}} | ||
};</code> | };</code> | ||
| [[isGameFocused]], [[isUIContext]], [[canSuspend]], [[isRemoteExecuted]], [[isRemoteExecutedJIP]], [[serverCommand]] | | [[isGameFocused]], [[isUIContext]], [[canSuspend]], [[isRemoteExecuted]], [[isRemoteExecutedJIP]], [[serverCommand]] | ||
| |MPBEHAVIOUR= | | |MPBEHAVIOUR= | ||
Revision as of 00:42, 18 January 2021
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.
- Groups:
- System
Syntax
- Syntax:
- isGamePaused
- Return Value:
- Boolean
Examples
- Example 1:
onEachFrame { if (isGamePaused) exitWith {}; // ...do stuff };
Additional Information
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