IsValidTimer: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|IsValidTimer(timer)}} {{FuncParameters}} {{FuncParam|timer|__EDIT_ME__}} {{FuncReturnValue|__EDIT...")
 
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server & Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Check if the timer identifier specified is valid or not.}}


{{FuncSyntax|IsValidTimer(timer)}}
{{FuncSyntax|IsValidTimer(timer)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|timer|__EDIT_ME__}}
{{FuncParam|timer|The timer identifier.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true''' on success.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua>
if IsValidTimer(timerid) then
return print("The specified timer id is valid.")
end
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{Template:TimerFunctions}}

Latest revision as of 10:14, 19 November 2019

IsValidTimer

Type: Function
Context: Server & Client
Introduced: v1.0

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

See also