setTimeout: Difference between revisions

Revision as of 01:41, 31 January 2024

Function Server and Client Online and Offline

Available since Server 1.0.0, Client 1.0.0

Timer setTimeout(function callback, int durationMilliseconds, [ ... ])

The setTimeout function is used to add a timer with a callback function that is invoked once after the specified duration has passed.

1)	int	durationMilliseconds	The duration, in milliseconds, before the scripting function is called.
2)	function	callback	The scripting function to call when the interval has occurred.
3)	vararg	...	Optional, defaults to n/a. The arguments to send to the callback function.

Timer	A handle to the timer.

function callback([...])

1)	...	vararg	The arguments that were sent to the `setTimeout` function.

50 milliseconds is the minimum duration available in setTimeout. Any duration less than 50 milliseconds isn't guaranteed to be called due to server process rate.

There aren't any examples for this function.

There isn't any compatibility information for this function.

@@ Line 13: / Line 13: @@
 |returnInfo = a handle to the timer
 |returnFail1 = null n/a
-|notes = Any durations less than 50 milliseconds aren't guaranteed to be called due to server process rate. 50 milliseconds is the minimum duration for performance reasons.
+|notes = 50 milliseconds is the minimum duration available in setTimeout. Any duration less than 50 milliseconds isn't guaranteed to be called due to server process rate.
 }}