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 - ";[ ]+ " to "; ") |
||
(15 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| arma3 | | |game1= arma3 | ||
|version1= 1.96 | |||
| | |gr1= System | ||
| | |descr= Returns the state of game simulation. Simulation can get paused by pressing {{KeyboardShortcut|ALT|TAB}} or a system dialog opening (e.g. {{KeyboardShortcut|ESC}} menu). Simulation will not get paused if <tt>-noPause</tt> [[Arma 3: Startup Parameters|startup parameter]] is used. | ||
{{Feature|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.}} | |||
| | |mp= In multiplayer the simulation will not get paused and this command will always return [[false]]. | ||
| | |s1= [[isGamePaused]] | ||
| [[Boolean]] | |r1= [[Boolean]] - Returns [[true]] if game simulation is paused, [[false]] if not | ||
|x1= <code>[[onEachFrame]] | |x1= <code>[[onEachFrame]] | ||
{ | { | ||
[[if]] ([[isGamePaused]]) [[exitWith]] {}; | [[if]] ([[isGamePaused]]) [[exitWith]] {}; | ||
{{cc|...do stuff}} | {{cc|...do stuff}} | ||
};</code> | };</code> | ||
| [[isGameFocused]] | |seealso= [[isGameFocused]] | ||
}} | }} | ||
Revision as of 00:55, 8 August 2021
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.
- 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