KillTimer: Difference between revisions

Revision as of 18:38, 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.

'Example 1: This example will kill an existing timer.

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

@@ Line 4: / Line 4: @@
 ==Syntax==
 <syntaxhighlight lang="lua">
-bool killTimer ( timerID )
+bool killTimer ( int timerID )
 </syntaxhighlight>
 ===Required Arguments===
-*'''timer:''' The timer you wish to halt.
+*'''timerID:''' The timer you wish to halt.
 ===Returns===
-Returns ''true'' if the timer was existing and killed, ''false'' if not.
+Returns ''true'' if a timer was successfully killed, ''false'' if no timer with the ID provided existed.
 ==Example==