sleep - Revision history

Killzone Kid at 17:40, 26 December 2024

2024-12-26T17:40:41Z

← Older revision		Revision as of 19:40, 26 December 2024
Line 18:		Line 18:
	\|gr1= Program Flow		\|gr1= Program Flow

	\|descr= Suspends code execution for given time in seconds. The sleep precision is given by a framerate, the delay given is the minimal delay expected. Must be called inside of a context which is interruptible, i.e. a [[Script Handle\|script]] executed by [[execVM]] or [[spawn]].		\|descr= Suspends code execution for given [[time]] in seconds. The sleep precision is given by a framerate, the delay given is the minimal delay expected. Must be called inside of a context which is interruptible, i.e. a [[Script Handle\|script]] executed by [[execVM]] or [[spawn]].
	{{Feature \| Informative \|		{{Feature \| Informative \|
	* this command will suspend the code for '''''at least''''' the given amount of time, and can be way more if the [[Scheduler\|script scheduler]] is busy.		* this command will suspend the code for '''''at least''''' the given amount of time, and can be way more if the [[Scheduler\|script scheduler]] is busy.
Line 42:		Line 42:
	</sqf>		</sqf>

	\|seealso= [[uiSleep]] [[waitUntil]] [[canSuspend]] [[execVM]] [[spawn]] [[sleep vs uiSleep]] [[Control Structures]]		\|seealso= [[time]] [[uiSleep]] [[waitUntil]] [[canSuspend]] [[execVM]] [[spawn]] [[sleep vs uiSleep]] [[Control Structures]]
	}}		}}

Lou Montana: Some wiki formatting

2022-04-05T16:28:00Z

Some wiki formatting

← Older revision		Revision as of 18:28, 5 April 2022
Line 30:		Line 30:
	\|r1= [[Nothing]]		\|r1= [[Nothing]]

	\|x1= <~~code~~>~~[] [[~~spawn]] {		\|x1= <sqf>
	[[sleep]] 5;		0 spawn {
	[[hint]] "after (at least) 5 seconds...";		sleep 5;
	};</~~code~~>		hint "after (at least) 5 seconds...";
			};
			</sqf>

	\|x2= <~~code~~>[[sleep]] 5 + [[random]] 10; ~~{{cc\|~~incorrect - will only sleep for 5 seconds, as it will be interpreted as (sleep 5) (+(random 10))}}		\|x2= <sqf>
	[[sleep]] (5 + [[random]] 10); ~~{{cc\|~~correct}}</~~code~~>		sleep 5 + random 10; // incorrect - will only sleep for 5 seconds, as it will be interpreted as (sleep 5) (+(random 10))
			sleep (5 + random 10); // correct
			</sqf>

	\|seealso= [[uiSleep]] [[waitUntil]] [[canSuspend]] [[execVM]] [[spawn]] [[sleep vs uiSleep]] [[Control Structures]]		\|seealso= [[uiSleep]] [[waitUntil]] [[canSuspend]] [[execVM]] [[spawn]] [[sleep vs uiSleep]] [[Control Structures]]

Lou Montana: False information cleanup

2022-01-20T17:25:06Z

False information cleanup

← Older revision		Revision as of 19:25, 20 January 2022
Line 38:		Line 38:
	[[sleep]] (5 + [[random]] 10); {{cc\|correct}}</code>		[[sleep]] (5 + [[random]] 10); {{cc\|correct}}</code>

	\|x3= ~~<code>~~[[if]] ([[~~isMultiplayer~~]]) [[~~then~~]]		\|seealso= [[uiSleep]] [[waitUntil]] [[canSuspend]] [[execVM]] [[spawn]] [[sleep vs uiSleep]] [[Control Structures]]
	{		}}
	[[~~uiSleep~~]] ~~3; {{cc\|more precise in (non-pausable) multiplayer}}~~
	} [[~~else~~]] {
	[[sleep]] ~~3; {{cc\|~~[[~~sleep~~]] ~~gets paused as the game is, usually wanted behaviour~~}}
	~~};</code>~~

	\|~~seealso~~= ~~[[uiSleep]] [[waitUntil]] [[canSuspend]], [[execVM]], [[spawn]]~~, [[~~sleep vs uiSleep~~]], [[~~Control Structures~~]]		{{Note
			\|user= CrashDome
			\|timestamp= 20061220205300
			\|text= Sleep suspends both SQF functions and SQF scripts. In functions, the calling script is still in suspension due to waiting for a return from the [[call]] command. The game engine will continue, however. See [[Function]] for more detail.
	}}		}}

	<~~dl class="command_description"~~>		{{Note
			\|user= Kronzky
			\|timestamp= 20070212201600
			\|text= Sleep durations between .0005 and .02 will cause the same delay (roughly .02 seconds).<br>
			Delays of .0005 and less have '''no''' effect (i.e, the sleep call will return immediately).
			}}

	~~<dt></dt>~~		{{Note
	~~<dd class~~=~~"notedate">Posted on December 20, 2006 - 19:53</dd>~~		\|user= Sbsmac
	~~<dt class~~=~~"note">[[User:CrashDome~~\|~~CrashDome]]</dt>~~		\|timestamp= 20070213223200
	~~<dd class~~=~~"note">Sleep suspends both SQF functions~~ and ~~SQF~~ scripts. ~~In functions,~~ the ~~calling~~ script ~~is still in suspension due~~ to ~~waiting~~ for ~~a return from~~ the ~~[[call]] command. The game engine will continue~~, ~~however. See [[Function]] for more detail.~~		\|text= The comment above is a little misleading. The game engine appears to work by processing frames and then checking to see whether scripts are available to execute.
	~~<dt><dt>~~		Sleep causes the script/function to be suspended until at least the specified time has elapsed.
	~~<dd class="notedate">Posted on February 12~~, ~~2007 - 20:16</dd>~~		To wait for the next frame, or give other scripts a chance to run, use Sleep 0.001.
	~~<dt class="note">[[User:Kronzky\|Kronzky]]</dt>~~		}}
	~~<dd class="note">~~Sleep ~~durations between~~ .~~0005 and .02 will cause the same delay (roughly .02 seconds).<br>Delays of .0005 and less have '''no''' effect (ie, the sleep call will return immediately)~~.

	~~<dt class="note">[[User:Sbsmac~~\|~~Sbsmac]]</dt>~~		{{Note
	~~<dd class~~="note">The comment above is a little misleading. The game engine appears to work by processing frames and then checking to see whether scripts are available to execute. Sleep causes the script/function to be suspended until at least the specified time has elapsed. To wait for the next frame, or give other scripts a chance to run, use Sleep 0.001.		\|user= Inkompetent
	~~<dt><dt>~~		\|timestamp= 20070616001300
	~~<dd class~~=~~"notedate">Posted on July 16, 2007 - 00:13</dd>~~		\|text= For scripts called by the [[Arma 3: Event Handlers#Init\|Init Event Handler]] the first sleep command will suspend the script at the briefing screen at the start of a mission. The script will continue after the briefing screen, when actually "in game".
	~~<dt class="note">[[User:Inkompetent~~\|~~Inkompetent]]</dt>~~		}}
	~~<dd class~~=~~"note">~~For scripts called by the [[~~Armed_Assault~~:~~_EventHandlers_List~~#Init\|Init Event Handler]] the first sleep command will suspend the script at the briefing screen at the start of a mission. The script will continue after the briefing screen, when actually "in game".
	~~<dt><dt>~~
	~~<dd class="notedate">Posted on October 18, 2014 - 21:24 (UTC)</dd>~~
	~~<dt class="note">[[User:AgentRevolution\|AgentRevolution]]</dt>~~
	~~<dd class="note">~~
	For server scripts, if you are creating "while true" timers, it is best to use [[uiSleep]] instead, as the sleep from that command is not slowed down by simulation / server lag, so the timers will execute at intervals that are much closer to real time, even under heavy lag.
	~~</dd>~~

	~~</dl>~~

Lou Montana: Text replacement - "\|seealso= *\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2"

2022-01-20T17:18:41Z

Text replacement - "\|seealso= *\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2"

← Older revision		Revision as of 19:18, 20 January 2022
Line 45:		Line 45:
	};</code>		};</code>

	\|seealso= [[uiSleep]] [[waitUntil]], [[canSuspend]], [[execVM]], [[spawn]], [[sleep vs uiSleep]], [[Control Structures]]		\|seealso= [[uiSleep]] [[waitUntil]] [[canSuspend]], [[execVM]], [[spawn]], [[sleep vs uiSleep]], [[Control Structures]]
	}}		}}

Lou Montana: Text replacement - "\|seealso= *\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2"

2022-01-20T17:13:37Z

Text replacement - "\|seealso= *\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2"

← Older revision		Revision as of 19:13, 20 January 2022
Line 45:		Line 45:
	};</code>		};</code>

	\|seealso= [[uiSleep]], [[waitUntil]], [[canSuspend]], [[execVM]], [[spawn]], [[sleep vs uiSleep]], [[Control Structures]]		\|seealso= [[uiSleep]] [[waitUntil]], [[canSuspend]], [[execVM]], [[spawn]], [[sleep vs uiSleep]], [[Control Structures]]
	}}		}}

Lou Montana: Text replacement - "[[Script (Handle)|" to "[[Script Handle|"

2021-08-28T17:07:00Z

Text replacement - "[[Script (Handle)|" to "[[Script Handle|"

← Older revision		Revision as of 19:07, 28 August 2021
Line 18:		Line 18:
	\|gr1= Program Flow		\|gr1= Program Flow

	\|descr= Suspends code execution for given time in seconds. The sleep precision is given by a framerate, the delay given is the minimal delay expected. Must be called inside of a context which is interruptible, i.e. a [[Script (Handle)\|script]] executed by [[execVM]] or [[spawn]].		\|descr= Suspends code execution for given time in seconds. The sleep precision is given by a framerate, the delay given is the minimal delay expected. Must be called inside of a context which is interruptible, i.e. a [[Script Handle\|script]] executed by [[execVM]] or [[spawn]].
	{{Feature \| Informative \|		{{Feature \| Informative \|
	* this command will suspend the code for '''''at least''''' the given amount of time, and can be way more if the [[Scheduler\|script scheduler]] is busy.		* this command will suspend the code for '''''at least''''' the given amount of time, and can be way more if the [[Scheduler\|script scheduler]] is busy.

Lou Montana: Text replacement - "\|s([0-9])\= '''([^' ]+)'''([^ ]+) " to "|s$1= $2$3 "

2021-06-20T16:12:52Z

Text replacement - "\|s([0-9])\= '''([^' ]+)'''([^ ]+) " to "|s$1= $2$3 "

← Older revision		Revision as of 18:12, 20 June 2021
Line 24:		Line 24:
	}}		}}

	\|s1= ~~'''~~sleep~~'''~~ delay		\|s1= [[sleep]] delay

	\|p1= delay: [[Number]] - in seconds. Negative values will not be considered.		\|p1= delay: [[Number]] - in seconds. Negative values will not be considered.

Lou Montana: Text replacement - " \| (game[0-9]|version[0-9]|gr[0-9]|serverExec|mp|pr|descr|s[0-9]|p[0-9]{1,3}|r[0-9]|x1?[0-9]|seealso) = +" to " |$1= "

2021-06-19T21:54:36Z

Text replacement - " \| *(game[0-9]|version[0-9]|gr[0-9]|serverExec|mp|pr|descr|s[0-9]|p[0-9]{1,3}|r[0-9]|x1?[0-9]|seealso) *= +" to " |$1= "

← Older revision		Revision as of 23:54, 19 June 2021
Line 24:		Line 24:
	}}		}}

	\|s1= '''sleep''' delay		\|s1= '''sleep''' delay

	\|p1= delay: [[Number]] - in seconds. Negative values will not be considered.		\|p1= delay: [[Number]] - in seconds. Negative values will not be considered.

Lou Montana: Text replacement - " \{\{GameCategory\|[a-z]+[0-9]?\|Scripting Commands\}\}" to ""

2021-06-16T21:46:39Z

Text replacement - " \{\{GameCategory\|[a-z]+[0-9]?\|Scripting Commands\}\}" to ""

← Older revision		Revision as of 23:46, 16 June 2021
Line 73:		Line 73:

	</dl>		</dl>

	~~{{GameCategory\|arma2\|Scripting Commands}}~~
	~~{{GameCategory\|arma3\|Scripting Commands}}~~
	~~{{GameCategory\|tkoh\|Scripting Commands}}~~

Lou Montana: Text replacement - "\| arma1 * \| ([0-1]\.[0-9]{2}) * \|game2" to "|game1= arma1 |version1= $1 |game2"

2021-06-13T23:27:25Z

Text replacement - "\| *arma1 * * *\| *([0-1]\.[0-9]{2}) * \|game2" to "|game1= arma1 |version1= $1 |game2"

← Older revision		Revision as of 01:27, 14 June 2021
Line 1:		Line 1:
	{{RV\|type=command		{{RV\|type=command

	\| arma1		\|game1= arma1
	\|1.00		\|version1= 1.00

	\|game2= arma2		\|game2= arma2

sleep - Revision history

Killzone Kid at 17:40, 26 December 2024

Lou Montana: Some wiki formatting

Lou Montana: False information cleanup

Lou Montana: Text replacement - "\|seealso= *\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2"

Lou Montana: Text replacement - "\|seealso= *\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2"

Lou Montana: Text replacement - "[[Script (Handle)|" to "[[Script Handle|"

Lou Montana: Text replacement - "\|s([0-9])\= '''([^' ]+)'''([^ ]+) " to "|s$1= $2$3 "

Lou Montana: Text replacement - " \| *(game[0-9]|version[0-9]|gr[0-9]|serverExec|mp|pr|descr|s[0-9]|p[0-9]{1,3}|r[0-9]|x1?[0-9]|seealso) *= +" to " |$1= "

Lou Montana: Text replacement - " \{\{GameCategory\|[a-z]+[0-9]?\|Scripting Commands\}\}" to ""

Lou Montana: Text replacement - "\| *arma1 * * *\| *([0-1]\.[0-9]{2}) * \|game2" to "|game1= arma1 |version1= $1 |game2"

Lou Montana: Text replacement - " \| (game[0-9]|version[0-9]|gr[0-9]|serverExec|mp|pr|descr|s[0-9]|p[0-9]{1,3}|r[0-9]|x1?[0-9]|seealso) = +" to " |$1= "

Lou Montana: Text replacement - "\| arma1 * \| ([0-1]\.[0-9]{2}) * \|game2" to "|game1= arma1 |version1= $1 |game2"