uiSleep: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma2 |Game name=
| arma2


|1.05|Game version=
|1.05


|gr1= Program Flow |GROUP1=
|gr1= Program Flow


| Suspend execution of script for given uitime.  uiSleep is a sleep method to delay script execution where script time/simulation time is stopped. uiSleep is basically using the system time (uiTime more specifically) and not simulation time. So in the cases where sleep command would get stuck indefinitely, uiSleep can still be used to effectively delay script execution. For example in a mission briefing or an editor or when simulation is paused in general. |DESCRIPTION=
| Suspend execution of script for given uitime.  uiSleep is a sleep method to delay script execution where script time/simulation time is stopped. uiSleep is basically using the system time (uiTime more specifically) and not simulation time. So in the cases where sleep command would get stuck indefinitely, uiSleep can still be used to effectively delay script execution. For example in a mission briefing or an editor or when simulation is paused in general.


| '''uiSleep''' delay |SYNTAX=
| '''uiSleep''' delay


|p1= delay : [[Number]] |PARAMETER1=
|p1= delay : [[Number]]


| [[Nothing]] |RETURNVALUE=
| [[Nothing]]
|x1 = <code> '''uiSleep''' 0.5 </code>
|x1 = <code> '''uiSleep''' 0.5 </code>
| [[sleep]], [[waitUntil]], [[canSuspend]], [[spawn]], [[execVM]], [[Control Structures]], [[sleep vs uiSleep]] |SEEALSO=
| [[sleep]], [[waitUntil]], [[canSuspend]], [[spawn]], [[execVM]], [[Control Structures]], [[sleep vs uiSleep]]


}}
}}

Revision as of 12:25, 18 January 2021

Hover & click on the images for description

Description

Description:
Suspend execution of script for given uitime. uiSleep is a sleep method to delay script execution where script time/simulation time is stopped. uiSleep is basically using the system time (uiTime more specifically) and not simulation time. So in the cases where sleep command would get stuck indefinitely, uiSleep can still be used to effectively delay script execution. For example in a mission briefing or an editor or when simulation is paused in general.
Groups:
Program Flow

Syntax

Syntax:
uiSleep delay
Parameters:
delay : Number
Return Value:
Nothing

Examples

Example 1:
uiSleep 0.5

Additional Information

See also:
sleepwaitUntilcanSuspendspawnexecVMControl Structuressleep vs uiSleep

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

Notes


Posted on March 28, 2016 - 10:40 (UTC)
R3vo
If the game is paused in SP (via ESC) the sleep command will stop working, to prevent that use uiSleep.