IsValidTimer: Difference between revisions
From Onset Developer Wiki
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Info|Function|Server & Client|1.0}} | {{Info|Function|Server & Client|1.0}} | ||
{{FuncDescription| | {{FuncDescription|Check if the timer identifier specified is valid or not.}} | ||
{{FuncSyntax|IsValidTimer(timer)}} | {{FuncSyntax|IsValidTimer(timer)}} | ||
{{FuncParameters}} | {{FuncParameters}} | ||
{{FuncParam|timer| | {{FuncParam|timer|The timer identifier.}} | ||
{{FuncReturnValue| | {{FuncReturnValue|Returns '''true''' on success.}} | ||
== Example == | == Example == | ||
<syntaxhighlight lang="Lua> | |||
if IsValidTimer(timerid) then | |||
return print("The specified timer id is valid.") | |||
end | |||
</syntaxhighlight> | |||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
{{Template:TimerFunctions}} | |||
Latest revision as of 10:14, 19 November 2019
Description
Check if the timer identifier specified is valid or not.
Syntax
IsValidTimer(timer)
Parameters
- timer
The timer identifier.
Return Value
- Returns true on success.
Example
if IsValidTimer(timerid) then
return print("The specified timer id is valid.")
end
