KillTimer: Difference between revisions

Revision as of 18:39, 5 June 2006

This function allows you to kill/halt existing timers, by passing a timerID as a parameter.

bool killTimer ( int timerID )

Returns true if a timer was successfully killed, false if no timer with the ID provided existed.

This example creates a timer then destroys it straight away.

myTimer = setTimer ( "delayedChat", 1000, 1, "Hello, World!" )
killTimer ( myTimer )

@@ Line 14: / Line 14: @@
 ==Example==
-'''Example 1:'' This example will kill an existing timer.
+This example creates a timer then destroys it straight away.
 <syntaxhighlight lang="lua">
-timer = setTimer ( "delayedChat", 1000, 1, "Hello, World!" )
+myTimer = setTimer ( "delayedChat", 1000, 1, "Hello, World!" )
-killTimer ( timer )
+killTimer ( myTimer )
 </syntaxhighlight>
 ==See Also==
 {{Utility functions}}