isGamePaused: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|game([0-9]) ?= (.+) \|version([0-9]) ?= (.+) " to "|game$1= $2 |version$3= $4 ")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *R([a-z ])" to "$1 - r$2")
 
(7 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 {{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.
|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|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.}}
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]].


|s1= [[isGamePaused]]
|s1= [[isGamePaused]]


|r1= [[Boolean]] - Returns [[true]] if game simulation is paused, [[false]] if not
|r1= [[Boolean]] - returns [[true]] if game simulation is paused, [[false]] if not


|x1= <code>[[onEachFrame]]
|x1= <sqf>
onEachFrame  
{
{
[[if]] ([[isGamePaused]]) [[exitWith]] {};  
if (isGamePaused) exitWith {};
{{cc|...do stuff}}
// ...do stuff
};</code>
};
</sqf>


|seealso= [[isGameFocused]]
|seealso= [[isGameFocused]]
}}
}}

Latest revision as of 15:47, 8 November 2023

Arma 3 logo black.png1.96
Hover & click on the images for description

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.
ⓘ
onEachFrame event and "EachFrame" event handler continue to execute when the simulation is paused, which could result in undesired backlog. Use isGamePaused to skip loop if needed.
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
Retrieved from "https://community.bistudio.com/wiki?title=isGamePaused&oldid=349063"