GetTimerDetails: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(OOP syntax added)
(Updated details about third returned value. (it was wrong before))
 
(One intermediate revision by one other user not shown)
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]]().


==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.


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")

Latest revision as of 13:34, 15 August 2020

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

Syntax

int, int, int getTimerDetails ( timer theTimer )

OOP Syntax Help! I don't understand this!

Method: timer:getDetails(...)


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 amount of times the timer has left to 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().

Example

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. 

theTimer = setTimer(function() end, 1000, 10) -- A timer that does nothing.

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

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetTimerDetails?oldid=67253"