CheckPassiveTimer - Revision history

IIYAMA: Adding a double dots to split a sentence.

2021-01-26T19:13:55Z

Adding a double dots to split a sentence.

← Older revision		Revision as of 19:13, 26 January 2021
Line 2:		Line 2:
	{{Useful Function}}		{{Useful Function}}

	This function allows you to use passive timers in your conditions. For example you want to prevent players repeatedly using a command.		This function allows you to use passive timers in your conditions. For example: you want to prevent players repeatedly using a command.

	==Syntax==		==Syntax==

2020-11-17T10:48:01Z

Rewritten incorrect comment

← Older revision		Revision as of 10:48, 17 November 2020
Line 41:		Line 41:
	end		end
	--[[		--[[
	Remove elements that are destroyed		Remove passive timers of elements that are destroyed
	]]		]]
	local function removeDeletedElementTimer ()		local function removeDeletedElementTimer ()

2020-08-23T10:49:04Z

Example

← Older revision		Revision as of 10:49, 23 August 2020
Line 155:		Line 155:
	addCommandHandler("candy",		addCommandHandler("candy",
	function ()		function ()
	local status, remainingTime = checkPassiveTimer("~~myTimer~~", true, 5000)		local status, remainingTime = checkPassiveTimer("candy timer 2", true, 5000)
	if status then		if status then
	outputChatBox("YES, EAT!")		outputChatBox("YES, EAT!")

2020-08-23T10:48:01Z

Example

← Older revision		Revision as of 10:48, 23 August 2020
Line 150:		Line 150:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>


	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">

2020-08-23T10:47:45Z

Returns

← Older revision		Revision as of 10:47, 23 August 2020
Line 17:		Line 17:
	Returns 2 values:		Returns 2 values:
	* '''timerState:''' The returned value is ''true'' if there is no passive timer or if that specific passive timer is expired, false otherwise.		* '''timerState:''' The returned value is ''true'' if there is no passive timer or if that specific passive timer is expired, false otherwise.
	* '''remainingTime:''' If there is no passive timer or the timer has been expired it will return the value 0.		* '''remainingTime:''' The returned value is the remaining time in milliseconds. If there is no passive timer or the timer has been expired it will return the value 0.

	==Code==		==Code==

2020-08-23T10:46:14Z

Example

@@ Line 146: / Line 146: @@
 	else
 		outputChatBox("NO CANDY FOR YOU!")
 	end
 end)

2020-08-23T10:45:18Z

Syntax

← Older revision		Revision as of 10:45, 23 August 2020
Line 6:		Line 6:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool checkPassiveTimer ( string timerName, mixed key, int timeInterval )		bool, int checkPassiveTimer ( string timerName, mixed key, int timeInterval )
	</syntaxhighlight>		</syntaxhighlight>

2020-08-23T10:44:54Z

Returns

← Older revision		Revision as of 10:44, 23 August 2020
Line 17:		Line 17:
	Returns 2 values:		Returns 2 values:
	* '''timerState:''' The returned value is ''true'' if there is no passive timer or if that specific passive timer is expired, false otherwise.		* '''timerState:''' The returned value is ''true'' if there is no passive timer or if that specific passive timer is expired, false otherwise.
	* '''~~Remaining time~~:''' If there is no passive timer or the timer has been expired it will return the value 0.		* '''remainingTime:''' If there is no passive timer or the timer has been expired it will return the value 0.

	==Code==		==Code==

2020-08-23T10:44:37Z

Returns

← Older revision		Revision as of 10:44, 23 August 2020
Line 16:		Line 16:
	===Returns===		===Returns===
	Returns 2 values:		Returns 2 values:
	* '''timerState:''' The returned value is ''true'' if there is no passive timer or if that specific passive timer is expired, false otherwise~~. Returns also the remaining time~~.		* '''timerState:''' The returned value is ''true'' if there is no passive timer or if that specific passive timer is expired, false otherwise.
	* '''Remaining time:''' If there is no passive timer or the timer has been expired it will return the value 0.		* '''Remaining time:''' If there is no passive timer or the timer has been expired it will return the value 0.

2020-08-23T10:44:21Z

Returns

← Older revision		Revision as of 10:44, 23 August 2020
Line 16:		Line 16:
	===Returns===		===Returns===
	Returns 2 values:		Returns 2 values:
	* '''timerState:''' ''true'' if there is no passive timer or if that specific passive timer is expired, false otherwise. Returns also the remaining time.		* '''timerState:''' The returned value is ''true'' if there is no passive timer or if that specific passive timer is expired, false otherwise. Returns also the remaining time.
	* '''Remaining time:''' If there is no passive timer or the timer has been expired it will return the value 0.		* '''Remaining time:''' If there is no passive timer or the timer has been expired it will return the value 0.