isGamePaused: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style='display:none'>Notes</h3> <dl class='command_description'> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> <h3 style='display:none'>Bottom Section</h3>" to "")
m (Text replacement - ";[ ]+ " to "; ")
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command
{{RV|type=command


| arma3
|game1= arma3
|version1= 1.96


|1.96
|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.
{{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.}}


| 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.
|mp= In multiplayer the simulation will not get paused and this command will always return [[false]].
<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. }}


| [[isGamePaused]]
|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]], [[isUIContext]], [[canSuspend]], [[isRemoteExecuted]], [[isRemoteExecutedJIP]], [[serverCommand]]
|seealso= [[isGameFocused]]
 
|  |MPBEHAVIOUR=
}}
}}
{{GameCategory|arma3|New Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Revision as of 01:55, 8 August 2021

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=292415"