KillTimer - Revision history

MarioKart: OOP syntax added

2014-07-12T07:01:56Z

OOP syntax added

← Older revision		Revision as of 07:01, 12 July 2014
Line 7:		Line 7:
	bool killTimer ( timer theTimer )		bool killTimer ( timer theTimer )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[timer]]:destroy\|\|}}
	===Required Arguments===		===Required Arguments===
	*'''theTimer:''' The [[timer]] you wish to halt.		*'''theTimer:''' The [[timer]] you wish to halt.

Mohammed-khalaf: /* Example */

2012-09-29T00:18:42Z

Example

← Older revision		Revision as of 00:18, 29 September 2012
Line 30:		Line 30:
	-- set timer output text in chat box		-- set timer output text in chat box
	local Timer = setTimer ( function ( ) outputChatBox ( 'Hello World !' ) end, 60000, 0 )		local Timer = setTimer ( function ( ) outputChatBox ( 'Hello World !' ) end, 60000, 0 )
	-- Check the timer kill the timer		-- Check the timer then kill the timer
	if isTimer ( Timer ) then killTimer ( Timer ) end		if isTimer ( Timer ) then killTimer ( Timer ) end
	</syntaxhighlight>		</syntaxhighlight>

Mohammed-khalaf: /* Example */

2012-09-28T23:30:51Z

Example

← Older revision		Revision as of 23:30, 28 September 2012
Line 24:		Line 24:
	killTimer ( timerValue )		killTimer ( timerValue )
	end		end
			</syntaxhighlight>

			This example checks if the time then kill the timer.
			<syntaxhighlight lang="lua">
			-- set timer output text in chat box
			local Timer = setTimer ( function ( ) outputChatBox ( 'Hello World !' ) end, 60000, 0 )
			-- Check the timer kill the timer
			if isTimer ( Timer ) then killTimer ( Timer ) end
	</syntaxhighlight>		</syntaxhighlight>

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

Pdescobar: /* Syntax */ argument is actually a timer object, not an int

2008-02-07T13:17:46Z

Syntax: argument is actually a timer object, not an int

← Older revision		Revision as of 13:17, 7 February 2008
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool killTimer ( ~~int timerID~~ )		bool killTimer ( timer theTimer )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''~~timerID~~:''' The timer you wish to halt.		*'''theTimer:''' The [[timer]] you wish to halt.

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

	==Example==		==Example==

Talidan: changed the pos example

2007-08-29T16:58:22Z

changed the pos example

← Older revision		Revision as of 16:58, 29 August 2007
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}}

Arc at 19:39, 16 August 2007

2007-08-16T19:39:59Z

← Older revision		Revision as of 19:39, 16 August 2007
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==		==Syntax==
Line 16:		Line 17:
	This example creates a timer then destroys it straight away.		This example creates a timer then destroys it straight away.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	myTimer = setTimer ( "delayedChat", 1000, 1, "Hello, World!" )		myTimer = setTimer ( delayedChat, 1000, 1, "Hello, World!" )
	killTimer ( myTimer )		killTimer ( myTimer )
	</syntaxhighlight>		</syntaxhighlight>

EAi: /* Example */

2006-06-05T18:39:49Z

Example

← Older revision		Revision as of 18:39, 5 June 2006
Line 14:		Line 14:

	==Example==		==Example==
	~~'''Example 1:''~~ This example ~~will kill an existing~~ timer.		This example creates a timer then destroys it straight away.

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~timer~~ = setTimer ( "delayedChat", 1000, 1, "Hello, World!" )		myTimer = setTimer ( "delayedChat", 1000, 1, "Hello, World!" )
	killTimer ( ~~timer~~ )		killTimer ( myTimer )
	</syntaxhighlight>		</syntaxhighlight>

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

EAi: /* Syntax */

2006-06-05T18:38:59Z

Syntax

← Older revision		Revision as of 18:38, 5 June 2006
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==

MrJax at 22:57, 3 June 2006

2006-06-03T22:57:17Z

← Older revision		Revision as of 22:57, 3 June 2006
Line 23:		Line 23:
	==See Also==		==See Also==
	{{Utility functions}}		{{Utility functions}}

	~~[[Category:Needs_Checking]]~~

MrJax at 22:48, 3 June 2006

2006-06-03T22:48:09Z

New page

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

==Syntax==
<syntaxhighlight lang="lua">
bool killTimer ( timerID )
</syntaxhighlight>

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

===Returns===
Returns ''true'' if the timer was existing and killed, ''false'' if not.

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

<syntaxhighlight lang="lua">
timer = setTimer ( "delayedChat", 1000, 1, "Hello, World!" )
killTimer ( timer )
</syntaxhighlight>

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

[[Category:Needs_Checking]]