uiSleep: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "Revo" to "R3vo")
m (Some wiki formatting)
 
(37 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.05


|1.05|Game version=
|game2= arma2oa
|version2= 1.50


|gr1= Program Flow |GROUP1=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| 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=
|game4= arma3
____________________________________________________________________________________________
|version4= 0.50


| '''uiSleep''' delay |SYNTAX=
|gr1= Program Flow


|p1= delay : [[Number]] |PARAMETER1=
|descr= Suspend execution of script for given UI time. [[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]] would get stuck indefinitely, [[uiSleep]] can still be used to effectively delay script execution for example in pause or in a mission briefing or an editor or when simulation is paused in general.


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


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


<h3 style="display:none">Notes</h3>
|r1= [[Nothing]]
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
|x1= In singleplayer:
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
<sqf>
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
setAccTime 0.25; // slows down time
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
sleep 1; // waits for 1 second in-game, 4 IRL seconds (1 / 0.25)
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]


setAccTime 0; // freezes simulation
// sleep 1; // would wait forever
uiSleep 1; // waits for 1 IRL second
</sqf>


<!-- CONTINUE Notes -->
|seealso= [[sleep]] [[waitUntil]] [[canSuspend]] [[spawn]] [[execVM]] [[Control Structures]] [[sleep vs uiSleep]]
<dl class="command_description">
}}
<dd class="notedate">Posted on March 28, 2016 - 10:40 (UTC)</dd>
<dt class="note">[[User:R3vo|R3vo]]</dt>
<dd class="note">
If the game is paused in SP (via ESC) the sleep command will stop working, to prevent that use uiSleep.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 02:27, 18 April 2023

Logo A2.png1.05A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Suspend execution of script for given UI time. 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 would get stuck indefinitely, uiSleep can still be used to effectively delay script execution for example in pause or 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:
In singleplayer:
setAccTime 0.25; // slows down time sleep 1; // waits for 1 second in-game, 4 IRL seconds (1 / 0.25) setAccTime 0; // freezes simulation // sleep 1; // would wait forever uiSleep 1; // waits for 1 IRL second

Additional Information

See also:
sleep waitUntil canSuspend spawn execVM Control Structures sleep 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
Retrieved from "https://community.bistudio.com/wiki?title=uiSleep&oldid=338950"