Difference between revisions of "GetTimers"

From Multi Theft Auto: Wiki
Line 1: Line 1:
 
__NOTOC__  
 
__NOTOC__  
 
{{Server client function}}
 
{{Server client function}}
This function returns a table of all active timers. Alternatively, only the timers with a remaining time less than or equal to a certain value can be retrieved.
+
This function returns a table of all active timers that the resource that calls it has created. Alternatively, only the timers with a remaining time less than or equal to a certain value can be retrieved.
  
 
==Syntax==  
 
==Syntax==  
Line 15: Line 15:
  
 
==Example==
 
==Example==
This example kills all timers with a remaining time of less than 1 minute.
+
This example kills timers with a remaining time of less than 1 minute.
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 
-- Find and kill all the timers with less than 1 minute to go
 
-- Find and kill all the timers with less than 1 minute to go

Revision as of 11:21, 13 February 2011

This function returns a table of all active timers that the resource that calls it has created. Alternatively, only the timers with a remaining time less than or equal to a certain value can be retrieved.

Syntax

table getTimers ( [ time ] )

Optional Arguments

  • time: The maximum time left (in milliseconds) on the timers you wish to retrieve.

Returns

Returns a table of all the active timers.

Example

This example kills timers with a remaining time of less than 1 minute.

-- Find and kill all the timers with less than 1 minute to go
timers = getTimers ( 60000 )
-- Loop through the timer list
for timerKey, timerValue in ipairs(timers) do
	-- kill the timer
      killTimer ( timerValue )
end

See Also