CreateCountTimer

From Onset Developer Wiki
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
CreateCountTimer

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

Description

Creates a countdown timer.

Syntax

CreateCountTimer(LuaFunction, Interval, Count [, UserArgs])

Parameters

  • LuaFunction
    The function to execute.
  • Interval
    Interval to execute the function.
  • Count
    How often to execute this timer. Use CreateTimer for a non-stop version.
  • 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
	CreateCountTimer(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, 16, vehicle)
end
AddCommand("vcolorfun", cmd_vcolorfun)

See also