KillTimer: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(changed the pos example)
Line 15: Line 15:


==Example==  
==Example==  
This example creates a timer then destroys it straight away.
This example kills all timers with a remaining time of less than 1 minute.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
myTimer = setTimer ( delayedChat, 1000, 1, "Hello, World!" )
-- Find and kill all the timers with less than 1 minute to go
killTimer ( myTimer )
timers = getTimers ( 60000 )
-- Loop through the timer list
for timerKey, timerValue in ipairs(timers) do
-- kill the timer
      killTimer ( timerValue )
end
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Utility functions}}
{{Utility functions}}

Revision as of 16:58, 29 August 2007

This function allows you to kill/halt existing timers.

Syntax

bool killTimer ( int timerID )

Required Arguments

  • timerID: The timer you wish to halt.

Returns

Returns true if a timer was successfully killed, false if no timer with the ID provided 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


Retrieved from "https://wiki.multitheftauto.com/wiki/KillTimer?oldid=11588"