uiSleep: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (template:command argument fix)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| 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.  |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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


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


}}
}}

Revision as of 15:50, 7 April 2019

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:
Uncategorised

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

Bottom Section

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