GetTimerDetails - Revision history

Srslyyyy: Updated details about third returned value. (it was wrong before)

2020-08-15T13:34:27Z

Updated details about third returned value. (it was wrong before)

← Older revision		Revision as of 13:34, 15 August 2020
Line 15:		Line 15:
	* Integer one represents the time left in miliseconds (1000th of a second) of the current time left in the loop.		* Integer one represents the time left in miliseconds (1000th of a second) of the current time left in the loop.
	* Integer two represents the amount of times the timer has left to execute.		* Integer two represents the amount of times the timer has left to execute.
	* Integer three represents the ~~amount~~ of ~~times the~~ timer ~~will execute~~.		* Integer three represents the time interval of timer.

	* Returns false if the timer doesn't exist or stopped running. Also, debugscript will say "Bad Argument @ 'getTimerDetails'". To prevent this, you can check if the timer exists with [[isTimer]]().		* Returns false if the timer doesn't exist or stopped running. Also, debugscript will say "Bad Argument @ 'getTimerDetails'". To prevent this, you can check if the timer exists with [[isTimer]]().
Line 25:		Line 25:

	function timerDetails()		function timerDetails()
	remaining, executesRemaining, ~~totalExecutes~~ = getTimerDetails(theTimer) -- Get the timers details		local remaining, executesRemaining, timeInterval = getTimerDetails(theTimer) -- Get the timers details
	if (remaining and executesRemaining and ~~totalExecutes~~) then		if (remaining and executesRemaining and timeInterval) then
	outputChatBox("Time remaining this second: "..remaining.." Executes remaining: "..executesRemaining.." ~~Total executes~~: "..~~totalExecutes~~)		outputChatBox("Time remaining this second: "..remaining.." Executes remaining: "..executesRemaining.." Time interval: "..timeInterval)
	else		else
	outputChatBox("Timer no longer exists")		outputChatBox("Timer no longer exists")

LordHenry: /* Example */

2017-09-01T14:21:53Z

Example

← Older revision		Revision as of 14:21, 1 September 2017
Line 20:		Line 20:

	==Example==		==Example==
	This example creates a 1 second (1000 ms) timer that will run ~~1000~~ times, and you can see the timer details by using the command: timerdetails.		This example creates a 1 second (1000 ms) timer that will run 10 times, and you can see the timer details by using the command: timerdetails.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	theTimer = setTimer(function() end, 1000, 10) -- A timer that does nothing.		theTimer = setTimer(function() end, 1000, 10) -- A timer that does nothing.

MarioKart: OOP syntax added

2014-07-12T07:05:30Z

OOP syntax added

← Older revision		Revision as of 07:05, 12 July 2014
Line 8:		Line 8:
	int, int, int getTimerDetails ( timer theTimer )		int, int, int getTimerDetails ( timer theTimer )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[timer]]:getDetails\|\|}}
	===Required Arguments===		===Required Arguments===
	*'''theTimer:''' A timer element.		*'''theTimer:''' A timer element.

Jusonex: fixed typo

2012-08-29T08:59:46Z

fixed typo

← Older revision		Revision as of 08:59, 29 August 2012
Line 14:		Line 14:
	===Returns===		===Returns===
	* Integer one represents the time left in miliseconds (1000th of a second) of the current time left in the loop.		* Integer one represents the time left in miliseconds (1000th of a second) of the current time left in the loop.
	* Integer two represents the ~~ammount~~ of times the timer has left to execute.		* Integer two represents the amount of times the timer has left to execute.
	* Integer three represents the ~~ammount~~ of times the timer will execute.		* Integer three represents the amount of times the timer will execute.

	* Returns false if the timer doesn't exist or stopped running. Also, debugscript will say "Bad Argument @ 'getTimerDetails'". To prevent this, you can check if the timer exists with [[isTimer]]().		* Returns false if the timer doesn't exist or stopped running. Also, debugscript will say "Bad Argument @ 'getTimerDetails'". To prevent this, you can check if the timer exists with [[isTimer]]().

Gamesnert at 21:46, 8 August 2010

2010-08-08T21:46:57Z

← Older revision		Revision as of 21:46, 8 August 2010
Line 34:		Line 34:
	addCommandHandler("timerdetails", timerDetails)		addCommandHandler("timerdetails", timerDetails)
	</syntaxhighlight>		</syntaxhighlight>

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

Gamesnert at 21:46, 8 August 2010

2010-08-08T21:46:09Z

← Older revision		Revision as of 21:46, 8 August 2010
Line 17:		Line 17:
	* Integer three represents the ammount of times the timer will execute.		* Integer three represents the ammount of times the timer will execute.

	* Returns false if the timer doesn't exist or stopped running. Also, debugscript will say "Bad ~~Arguement~~ @ 'getTimerDetails'" to prevent this you can check if the timer exists with [[isTimer]]().		* Returns false if the timer doesn't exist or stopped running. Also, debugscript will say "Bad Argument @ 'getTimerDetails'". To prevent this, you can check if the timer exists with [[isTimer]]().

	==Example==		==Example==

ArranTuna: /* Returns */

2010-08-08T21:29:10Z

Returns

← Older revision		Revision as of 21:29, 8 August 2010
Line 17:		Line 17:
	* Integer three represents the ammount of times the timer will execute.		* Integer three represents the ammount of times the timer will execute.

	* Returns false if the timer doesn't exist or stopped running. Also, debugscript is will say "Bad Arguement @ 'getTimerDetails'"		* Returns false if the timer doesn't exist or stopped running. Also, debugscript will say "Bad Arguement @ 'getTimerDetails'" to prevent this you can check if the timer exists with [[isTimer]]().

	==Example==		==Example==

ArranTuna at 14:08, 8 August 2010

2010-08-08T14:08:55Z

← Older revision		Revision as of 14:08, 8 August 2010
Line 6:		Line 6:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	int, int, int [[getTimerDetails]] ( timer theTimer )		int, int, int getTimerDetails ( timer theTimer )
	</syntaxhighlight>		</syntaxhighlight>

ArranTuna at 14:08, 8 August 2010

2010-08-08T14:08:21Z

← Older revision		Revision as of 14:08, 8 August 2010
Line 6:		Line 6:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	int, int, int getTimerDetails ( timer theTimer )		int, int, int [[getTimerDetails]] ( timer theTimer )
	</syntaxhighlight>		</syntaxhighlight>

ArranTuna: Created page with 'NOTOC {{Server client function}} This function is for getting the details of a running timer. ==Syntax== int, int, int getTimerDetails ( timer theTimer )
2010-08-08T14:07:45Z

Created page with 'NOTOC {{Server client function}} This function is for getting the details of a running timer. ==Syntax== <syntaxhighlight lang="lua"> int, int, int getTimerDetails ( timer theTimer ) </…'

New page
NOTOC
{{Server client function}}

This function is for getting the details of a running timer.

==Syntax==
<syntaxhighlight lang="lua">
int, int, int getTimerDetails ( timer theTimer )
</syntaxhighlight>

===Required Arguments===
'''theTimer:''' A timer element.

===Returns===
Integer one represents the time left in miliseconds (1000th of a second) of the current time left in the loop.
* Integer two represents the ammount of times the timer has left to execute.
* Integer three represents the ammount of times the timer will execute.

* Returns false if the timer doesn't exist or stopped running. Also, debugscript is will say "Bad Arguement @ 'getTimerDetails'"

==Example==
This example creates a 1 second (1000 ms) timer that will run 1000 times, and you can see the timer details by using the command: timerdetails.
<syntaxhighlight lang="lua">
theTimer = setTimer(function() end, 1000, 10) -- A timer that does nothing.

function timerDetails()
remaining, executesRemaining, totalExecutes = getTimerDetails(theTimer) -- Get the timers details
if (remaining and executesRemaining and totalExecutes) then
outputChatBox("Time remaining this second: "..remaining.." Executes remaining: "..executesRemaining.." Total executes: "..totalExecutes)
else
outputChatBox("Timer no longer exists")
end
end
addCommandHandler("timerdetails", timerDetails)
</syntaxhighlight>