KillTimer: Difference between revisions

Revision as of 19:39, 16 August 2007

This function allows you to kill/halt existing timers.

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 1: / Line 1: @@
-__NOTOC__
+{{Server client function}}
-This function allows you to kill/halt existing timers, by passing a timerID as a parameter.
+__NOTOC__
+This function allows you to kill/halt existing timers.
 ==Syntax==
@@ Line 16: / Line 17: @@
 This example creates a timer then destroys it straight away.
 <syntaxhighlight lang="lua">
-myTimer = setTimer ( "delayedChat", 1000, 1, "Hello, World!" )
+myTimer = setTimer ( delayedChat, 1000, 1, "Hello, World!" )
 killTimer ( myTimer )
 </syntaxhighlight>