isGamePaused: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\{\{GameCategory\|(arma[0123])\|[ _]?New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| arma3 |Game name= | | arma3 |Game name= | ||
| Line 7: | Line 6: | ||
|gr1= System |GROUP1= | |gr1= System |GROUP1= | ||
| 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. }} |DESCRIPTION= | <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. }} |DESCRIPTION= | ||
| [[isGamePaused]] |SYNTAX= | | [[isGamePaused]] |SYNTAX= | ||
| Line 22: | Line 19: | ||
{{cc|...do stuff}} | {{cc|...do stuff}} | ||
};</code>|EXAMPLE1= | };</code>|EXAMPLE1= | ||
| [[isGameFocused]], [[isUIContext]], [[canSuspend]], [[isRemoteExecuted]], [[isRemoteExecutedJIP]], [[serverCommand]] |SEEALSO= | | [[isGameFocused]], [[isUIContext]], [[canSuspend]], [[isRemoteExecuted]], [[isRemoteExecutedJIP]], [[serverCommand]] |SEEALSO= | ||
Revision as of 01:45, 17 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