GetTimers: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
This function returns a table of all the timers (with the remaining time left below or equal to the time specified)
{{Server client function}}
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==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
table getTimers ( [ time ] )
table getTimers ( [ int theTime = nil ] )
</syntaxhighlight>  
</syntaxhighlight>  


===Optional Arguments===  
===Optional Arguments===  
*'''time:''' The maximum time left(ms) on the timers you wish to add to the table.
*'''theTime:''' The maximum time left (in milliseconds) on the timers you wish to retrieve.


===Returns===
===Returns===
Line 14: Line 15:


==Example==
==Example==
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
Line 20: Line 22:
for timerKey, timerValue in ipairs(timers) do
for timerKey, timerValue in ipairs(timers) do
-- kill the timer
-- kill the timer
        killTimer ( timerValue )
      killTimer ( timerValue )
end
end
</syntaxhighlight>
</syntaxhighlight>

Latest revision as of 11:26, 6 March 2019

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 ( [ int theTime = nil ] )

Optional Arguments

  • theTime: 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


Retrieved from "https://wiki.multitheftauto.com/wiki/GetTimers?oldid=62324"