isGamePaused: Difference between revisions
Jump to navigation
Jump to search
(formatting) |
m (Esc note) |
||
| Line 7: | Line 7: | ||
|gr1= System | |gr1= System | ||
|descr= Returns the state of game simulation. Simulation can get paused by pressing {{KeyboardShortcut|ALT|TAB}} or a system dialog opening. Simulation will not get paused if <tt>-noPause</tt> [[Arma 3: Startup Parameters|startup parameter]] is used. | |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.}} | {{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.}} | ||
Revision as of 07:02, 21 March 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 true.
- 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