setImmediate: Difference between revisions

Revision as of 20:37, 19 November 2022

Function Server and Client Online and Offline

Available since Server 1.0.0, Client 1.0.0

Timer setImmediate(function callback, [ vararg ... = n/a ])

The setImmediate function is used to add a timer with a callback function that is invoked on the next tick.

1)	function	callback	The scripting function to call on the next tick.
2)	vararg	...	Optional, defaults to n/a. The arguments to send to the callback function.

Timer	A handle to the timer.

function callback(... vararg)

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

There aren't any notes for this function.

There aren't any examples for this function.

There isn't any compatibility information for this function.

@@ Line 1: / Line 1: @@
-{{ScriptItem
+{{ScriptItem2
-|endpoint = shared
+|name = setImmediate
+|side = shared
 |type = function
-|name = setImmediate
+|games = iii vc sa iv
-|usage = add a timer with a callback function that is invoked on the next tick
+|desc = add a timer with a callback function that is invoked on the next tick
-|parameters = function callback, [ ... ]
+|arg1 = function callback The scripting function to call on the next tick.
-|parameter1 = function callback The scripting function to call on the next tick.
+|arg2 = [vararg ... = n/a] The arguments to send to the callback function.
-|parameter2 = vararg ... optional n/a The arguments to send to the callback function.
+|return = Timer a handle to the timer
-|callback1Syntax = [...]
+|freturn = null n/a
-|callback1Parameter1 = ... vararg The arguments that were sent to the <code>setImmediate</code> function.
+|cb1arg1 = ... vararg The arguments that were sent to the <code>setImmediate</code> function.
-|returnTypes = Timer
-|returnInfo = a handle to the timer
-|returnFail1 = null n/a
 }}