setInterval: Difference between revisions

Revision as of 01:44, 31 January 2024

Function Server and Client Online and Offline

Available since Server 1.0.0, Client 1.0.0

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

The setInterval function is used to add a timer with a callback function that is invoked each time the specified duration has passed.

1)	int	durationMilliseconds	The interval, in milliseconds, to call the scripting function.
2)	function	callback	The scripting function to call when each 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 `setInterval` function.

GTA Connected guarantees that the timer will be triggered after at least the interval you specify. The resolution of the timer is tied to the frame rate (server side and client-side). All the overdue timers are triggered at a single point each frame. This means that if, for example, the player is running at 30 frames per second, then two timers specified to occur after 100ms and 110ms would more than likely occur during the same frame, as the difference in time between the two timers (10ms) is less than half the length of the frame (33ms). As with most timers provided by other languages, you shouldn't rely on the timer triggering at an exact point in the future.

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 = GTA Connected guarantees that the timer will be triggered after at least the interval you specify. The resolution of the timer is tied to the frame rate (server side and client-side). All the overdue timers are triggered at a single point each frame. This means that if, for example, the player is running at 30 frames per second, then two timers specified to occur after 100ms and 110ms would more than likely occur during the same frame, as the difference in time between the two timers (10ms) is less than half the length of the frame (33ms). As with most timers provided by other languages, you shouldn't rely on the timer triggering at an exact point in the future.
 }}