CreateTimer: Difference between revisions
From Onset Developer Wiki
No edit summary |
No edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{Info|Function|Server & Client|1.0}} | {{Info|Function|Server & Client|1.0}} | ||
{{FuncDescription|Creates a timer to call a latent function.}} | {{FuncDescription|Creates a timer to call a latent function. | ||
Variations of this function: | |||
* [[CreateCountTimer]] | |||
* [[Delay]]}} | |||
{{FuncSyntax|CreateTimer(LuaFunction, Interval [, UserArgs])}} | {{FuncSyntax|CreateTimer(LuaFunction, Interval [, UserArgs])}} | ||
| Line 10: | Line 13: | ||
{{FuncParamOptional|UserArgs|Arguments to pass to the function.}} | {{FuncParamOptional|UserArgs|Arguments to pass to the function.}} | ||
{{FuncReturnValue| | {{FuncReturnValue|Returns the identifier to this timer. Use [[DestroyTimer]] to stop it.}} | ||
== Example == | == Example == | ||
| Line 25: | Line 28: | ||
end | end | ||
--Change color every 200ms of the players vehicle | |||
CreateTimer(function(vehicle) | CreateTimer(function(vehicle) | ||
if not IsValidVehicle(vehicle) then | if not IsValidVehicle(vehicle) then | ||
| Line 40: | Line 43: | ||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
{{Template:TimerFunctions}} | |||
Latest revision as of 10:17, 19 November 2019
Description
Creates a timer to call a latent function. Variations of this function:
Syntax
CreateTimer(LuaFunction, Interval [, UserArgs])
Parameters
- LuaFunction
The function to execute. - Interval
Interval to execute the function. - UserArgs (optional)
Arguments to pass to the function.
Return Value
- Returns the identifier to this timer. Use DestroyTimer to stop it.
Example
function cmd_vcolorfun(player)
local vehicle = GetPlayerVehicle(player)
if (vehicle == 0) then
return AddPlayerChat(player, "You must be in a vehicle")
end
if (GetPlayerVehicleSeat(player) ~= 1) then
return AddPlayerChat(player, "You must be the driver of the vehicle")
end
--Change color every 200ms of the players vehicle
CreateTimer(function(vehicle)
if not IsValidVehicle(vehicle) then
return
end
local r = Random(100, 255)
local g = Random(100, 255)
local b = Random(100, 255)
SetVehicleColor(vehicle, RGB(r, g, b))
end, 200, vehicle)
end
AddCommand("vcolorfun", cmd_vcolorfun)
