uiSleep: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "<dl class="command_description"> <dt></dt>" to "<dl class="command_description"> <dt></dt>") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
(15 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{RV|type=command | {{RV|type=command | ||
| arma2 | |game1= arma2 | ||
|1.05 | |version1= 1.05 | ||
|game2= arma2oa | |game2= arma2oa | ||
Line 15: | Line 15: | ||
|gr1= Program Flow | |gr1= Program Flow | ||
| Suspend execution of script for given | |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. | |||
| | |s1= [[uiSleep]] delay | ||
|p1= delay : [[Number]] | |p1= delay: [[Number]] | ||
|r1= [[Nothing]] | |r1= [[Nothing]] | ||
|x1= < | |x1= In singleplayer: | ||
<sqf> | |||
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 | |||
</sqf> | |||
|seealso= [[sleep]] [[waitUntil]] [[canSuspend]] [[spawn]] [[execVM]] [[Control Structures]] [[sleep vs uiSleep]] | |||
}} | |||
Latest revision as of 02:27, 18 April 2023
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
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
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