IsTimer - Revision history

MarioKart: OOP syntax added

2014-07-12T07:03:56Z

OOP syntax added

← Older revision		Revision as of 07:03, 12 July 2014
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">bool isTimer ( timer theTimer )</syntaxhighlight>		<syntaxhighlight lang="lua">bool isTimer ( timer theTimer )</syntaxhighlight>
			{{OOP\|\|[[timer]]:isValid\|valid\|}}
	===Required Arguments===		===Required Arguments===
	* '''theTimer''': The variable that we want to check.		* '''theTimer''': The variable that we want to check.

Ccw at 23:29, 20 April 2014

2014-04-20T23:29:57Z

← Older revision		Revision as of 23:29, 20 April 2014
Line 2:		Line 2:
	{{Server client function}}		{{Server client function}}
	This function checks if a variable is a [[timer]].		This function checks if a variable is a [[timer]].
			{{Note\|This function is not reliable as timer ids are eventually recycled. Always make sure you nil variables containing a timer after it has expired.}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">bool isTimer ( timer theTimer )</syntaxhighlight>		<syntaxhighlight lang="lua">bool isTimer ( timer theTimer )</syntaxhighlight>

Ransom: /* Example */

2014-01-18T23:57:12Z

Example

← Older revision		Revision as of 23:57, 18 January 2014
Line 23:		Line 23:
	if isTimer(antiSpam[source]) then -- Check if timer is running using isTimer (this is an example of its use and all)		if isTimer(antiSpam[source]) then -- Check if timer is running using isTimer (this is an example of its use and all)
	cancelEvent() -- If timer is running then cancel the event		cancelEvent() -- If timer is running then cancel the event
	outputChatBox("Sorry ~~mate~~, you may only send 1 message a second to prevent spam.", source, 255, 255, 0) -- Message to player		outputChatBox("Sorry bro, you may only send 1 message a second to prevent spam.", source, 255, 255, 0) -- Message to player
	else		else
	antiSpam[source] = setTimer(function(source) antiSpam[source] = nil end, 1000, 1, source) -- Timer lasting 1 second.		antiSpam[source] = setTimer(function(source) antiSpam[source] = nil end, 1000, 1, source) -- Timer lasting 1 second.

Ixjf: /* Required Arguments */

2013-06-28T21:18:57Z

Required Arguments

← Older revision		Revision as of 21:18, 28 June 2013
Line 7:		Line 7:

	===Required Arguments===		===Required Arguments===
	* '''~~timer~~ theTimer''': The variable that we want to check.		* '''theTimer''': The variable that we want to check.

	===Returns===		===Returns===

Ixjf: /* Syntax */

2013-06-28T21:18:39Z

Syntax

← Older revision		Revision as of 21:18, 28 June 2013
Line 4:		Line 4:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">bool isTimer ( ~~var theVariable~~ )</syntaxhighlight>		<syntaxhighlight lang="lua">bool isTimer ( timer theTimer )</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	* '''~~theVariable~~''': The variable that we want to check.		* '''timer theTimer''': The variable that we want to check.

	===Returns===		===Returns===

Sebassje at 15:51, 21 June 2010

2010-06-21T15:51:54Z

← Older revision		Revision as of 15:51, 21 June 2010
Line 4:		Line 4:

	==Syntax==		==Syntax==
	~~<section name="Server and client" class="both" show="true">~~
	<syntaxhighlight lang="lua">bool isTimer ( var theVariable )</syntaxhighlight>		<syntaxhighlight lang="lua">bool isTimer ( var theVariable )</syntaxhighlight>

Line 12:		Line 11:
	===Returns===		===Returns===
	Returns ''true'' if the passed value is a timer, ''false'' otherwise.		Returns ''true'' if the passed value is a timer, ''false'' otherwise.
	~~</section>~~

	==Example==		==Example==

50p at 19:59, 16 April 2010

2010-04-16T19:59:34Z

← Older revision		Revision as of 19:59, 16 April 2010
Line 39:		Line 39:
	==See Also==		==See Also==
	{{Utility functions}}		{{Utility functions}}
	~~[[Category:Needs Example]]~~

Mr.Tuna: /* Example */

2010-04-16T12:02:00Z

Example

← Older revision		Revision as of 12:02, 16 April 2010
Line 15:		Line 15:

	==Example==		==Example==
			<section name="Server" class="server" show="true">
			This example uses isTimer to prevent players from using chat/teamchat/me more than once a second, to prevent spammers.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--~~TODO~~		-- This anti spam is just an example and won't work if you have other scripts and game modes which manipulate chat,
			-- If you do then this script would need to be put with the other script/gamemode that handles chat else cancelEvent() won't work.

			antiSpam = {} -- This makes a table called antiSpam
			function antiChatSpam() -- The function that the event has called. Will stop all mainchat/teamchat/me spam.
			if isTimer(antiSpam[source]) then -- Check if timer is running using isTimer (this is an example of its use and all)
			cancelEvent() -- If timer is running then cancel the event
			outputChatBox("Sorry mate, you may only send 1 message a second to prevent spam.", source, 255, 255, 0) -- Message to player
			else
			antiSpam[source] = setTimer(function(source) antiSpam[source] = nil end, 1000, 1, source) -- Timer lasting 1 second.
			-- The "function(source) antiSpam[source] = nil end" should clear the player from table after 1 second so he can chat again.
			-- antiSpam[source] = setTimer(... is using the table to bind that player to the timer.
			end
			end
			addEventHandler("onPlayerChat", root, antiChatSpam) -- Event we're using, don't waste your time with getRootElement() (root is the same)
			-- You now have an antispam to prevent people super spamming your chatbox!
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{Utility functions}}		{{Utility functions}}
	[[Category:Needs Example]]		[[Category:Needs Example]]

Awwu: Needs example

2009-06-19T07:53:49Z

Needs example

← Older revision		Revision as of 07:53, 19 June 2009
Line 21:		Line 21:
	==See Also==		==See Also==
	{{Utility functions}}		{{Utility functions}}
			[[Category:Needs Example]]

EAi at 12:17, 24 May 2009

2009-05-24T12:17:00Z

← Older revision		Revision as of 12:17, 24 May 2009
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function checks if a variable is a [[timer]] ~~and the it still exists~~.		This function checks if a variable is a [[timer]].

	==Syntax==		==Syntax==
Line 11:		Line 11:

	===Returns===		===Returns===
	Returns ''true'' if the passed value is a timer ~~and it still exists~~, ''false'' otherwise.		Returns ''true'' if the passed value is a timer, ''false'' otherwise.
	</section>		</section>