View source for IsTimer

<!-- This page is generated automatically from the function definition: isTimer. -->
= isTimer =
Checks whether a timer identifier still refers to an active timer.

== Syntax ==
<syntaxhighlight lang="lua">
bool isTimer(int timerId)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>timerId</code> || <code>int</code> || yes || The timer identifier to inspect.
|}

== Returns ==
Returns <code>true</code> for an active timer; otherwise returns <code>false</code>.

== Examples ==
Check a timer before cancelling it:
<syntaxhighlight lang="lua" line>
local timer = setTimer(function() end, 5000, 1)
if isTimer(timer) then
    killTimer(timer)
end
</syntaxhighlight>

== Notes ==
* Available in both client-side and server-side resource scripts.

[[Category:Shared Functions]]
[[Category:Timer Functions]]
[[Category:Utility Functions]]