KillTimer

From Multi Theft Auto: Wiki
Revision as of 13:17, 7 February 2008 by Pdescobar (talk | contribs) (→‎Syntax: argument is actually a timer object, not an int)
Jump to navigation Jump to search

This function allows you to kill/halt existing timers.

Syntax

bool killTimer ( timer theTimer )

Required Arguments

  • theTimer: The timer you wish to halt.

Returns

Returns true if the timer was successfully killed, false if no such timer existed.

Example

This example kills all 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