CreateCountTimer: Difference between revisions

From Onset Developer Wiki
Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|CreateCountTimer(LuaFunction, Interval, Count [, UserArgs])}} {{FuncParameters}} {{FuncParam|LuaFu..."
 
No edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server & Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Creates a countdown timer.}}


{{FuncSyntax|CreateCountTimer(LuaFunction, Interval, Count [, UserArgs])}}
{{FuncSyntax|CreateCountTimer(LuaFunction, Interval, Count [, UserArgs])}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|LuaFunction|__EDIT_ME__}}
{{FuncParam|LuaFunction|The function to execute.}}
{{FuncParam|Interval|__EDIT_ME__}}
{{FuncParam|Interval|Interval to execute the function.}}
{{FuncParam|Count |__EDIT_ME__}}
{{FuncParam|Count|How often to execute this timer. Use [[CreateTimer]] for a non-stop version.}}
{{FuncParamOptional|UserArgs|__EDIT_ME__}}
{{FuncParamOptional|UserArgs|Arguments to pass to the function.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns the identifier to this timer. Use [[DestroyTimer]] to stop it.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
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)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{Template:TimerFunctions}}

Latest revision as of 11:21, 1 September 2020

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