KillTimer: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 4: Line 4:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool killTimer ( timerID )
bool killTimer ( int timerID )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''timer:''' The timer you wish to halt.
*'''timerID:''' The timer you wish to halt.


===Returns===
===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==  
==Example==  

Revision as of 18:38, 5 June 2006

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

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

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

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

See Also