Difference between revisions of "Timer.Remove"

From Nomad DB
(Created page with "Removes a named timer which was created by timer.Create. This function does not work with simple timers. {{Warning|This function causes an error if a timer with the given...")
 
 
Line 5: Line 5:
 
== Syntax ==
 
== Syntax ==
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
timer.Get(name)
+
timer.Remove(name)
timer.Get(instance)
+
timer.Remove(instance)
 
</syntaxhighlight>
 
</syntaxhighlight>
 
# '''name:''' string (Timer name)
 
# '''name:''' string (Timer name)

Latest revision as of 11:16, 3 August 2020

Removes a named timer which was created by timer.Create. This function does not work with simple timers.

This function causes an error if a timer with the given name does not exist. It is recommended to use timer.RemoveIfExists instead.

Syntax

timer.Remove(name)
timer.Remove(instance)
  1. name: string (Timer name)
  2. instance: Timer (use timer.Get to acquire an instance)

Related Pages