CreateTimer

From Onset Developer Wiki
CreateTimer

Type: Function
Context: Server & Client
Introduced: v1.0

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)

See also

__EDIT_ME__