ResetTimer: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Improve comment in example.)
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Server function}}
{{Server client function}}
__NOTOC__
__NOTOC__
This function allows you to reset the elapsed time in existing timers to zero. The function does not reset the 'times to execute' count on timers which have a limited amout of repetitions.
This function allows you to reset the elapsed time in existing timers to zero. The function does not reset the 'times to execute' count on timers which have a limited amout of repetitions.
Line 7: Line 7:
bool resetTimer ( timer theTimer )
bool resetTimer ( timer theTimer )
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[timer]]:reset||}}
===Required Arguments===  
===Required Arguments===  
*'''theTimer:''' The [[timer]] whose elapsed time you wish to reset.
*'''theTimer:''' The [[timer]] whose elapsed time you wish to reset.
Line 16: Line 16:
==Example==  
==Example==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
-- This example shows how you can reset timer by using /rtimer command.
 
local timerElement = false
 
function timerFunction()
print("Timer function executed at "..getTickCount())
end
timerElement = setTimer(timerFunction, 3000, 0)
 
function timerResetCommand()
local validTimer = isTimer(timerElement)
 
if validTimer then
print("Timer has been resetted.")
resetTimer(timerElement)
end
end
addCommandHandler("rtimer", timerResetCommand)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Utility functions}}
{{Utility functions}}
[[Category:Needs_Example]]

Latest revision as of 06:33, 30 June 2022

This function allows you to reset the elapsed time in existing timers to zero. The function does not reset the 'times to execute' count on timers which have a limited amout of repetitions.

Syntax

bool resetTimer ( timer theTimer )

OOP Syntax Help! I don't understand this!

Method: timer:reset(...)


Required Arguments

  • theTimer: The timer whose elapsed time you wish to reset.

Returns

Returns true if the timer was successfully reset, false otherwise.

Example

-- This example shows how you can reset timer by using /rtimer command.

local timerElement = false

function timerFunction()
	print("Timer function executed at "..getTickCount())
end
timerElement = setTimer(timerFunction, 3000, 0)

function timerResetCommand()
	local validTimer = isTimer(timerElement)

	if validTimer then
		print("Timer has been resetted.")
		resetTimer(timerElement)
	end
end
addCommandHandler("rtimer", timerResetCommand)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/ResetTimer?oldid=75199"