isGamePaused: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " \| *(game[0-9]|version[0-9]|gr[0-9]|serverExec|mp|pr|descr|s[0-9]|p[0-9]{1,3}|r[0-9]|x1?[0-9]|seealso) *= +" to " |$1= ") |
Lou Montana (talk | contribs) m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *R([a-z ])" to "$1 - r$2") |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 6: | Line 6: | ||
|gr1= System | |gr1= System | ||
|descr= Returns the state of game simulation. Simulation can get paused by pressing {{ | |descr= Returns the state of game simulation. Simulation can get paused by pressing {{Controls|Alt|Tab}} or a system dialog opening (e.g. {{Controls|Esc}} menu). | ||
{{Feature| | Simulation will not get paused if {{hl|-noPause}} [[Arma 3: Startup Parameters|startup parameter]] is used. | ||
{{Feature|informative|[[onEachFrame]] event and {{hl|"EachFrame"}} 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]]. | |mp= In multiplayer the simulation will not get paused and this command will always return [[false]]. | ||
| Line 13: | Line 14: | ||
|s1= [[isGamePaused]] | |s1= [[isGamePaused]] | ||
|r1= [[Boolean]] - | |r1= [[Boolean]] - returns [[true]] if game simulation is paused, [[false]] if not | ||
|x1= < | |x1= <sqf> | ||
onEachFrame | |||
{ | { | ||
if (isGamePaused) exitWith {}; | |||
// ...do stuff | |||
};</ | }; | ||
</sqf> | |||
|seealso= [[isGameFocused]] | |seealso= [[isGameFocused]] | ||
}} | }} | ||
Latest revision as of 15:47, 8 November 2023
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:
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