Script function
world.ResetTimer
Read about scripting
Type
Method
Summary
Resets a named timer
Prototype
long ResetTimer(BSTR TimerName);
View list of data type meanings
Description
Resets the named timer.
Also see ResetTimers to reset all timers.
WARNING - timers that are not enabled will not be reset. Use EnableTimer first to make sure the timer is enabled, before resetting it, if necessary.
VBscript example
world.ResetTimer "mytimer"
Jscript example
world.ResetTimer("mytimer");
PerlScript example
$world->ResetTimer("mytimer");
Python example
world.ResetTimer("mytimer")
Lua example
ResetTimer("mytimer")
Return value
eInvalidObjectLabel: The timer name is not valid
eTimerNotFound: The timer does not exist
eOK: reset OK
View list of return code meanings
See Also ...
Topics
Aliases
Default triggers/aliases/timers/macros/colours
Getting started
Groups
Plugins
Timers
Triggers
Functions
(AddTimer) Adds a timer
(DeleteTemporaryTimers) Deletes all temporary timers
(DeleteTimer) Deletes a timer
(DeleteTimerGroup) Deletes a group of timers
(DoAfter) Adds a one-shot, temporary timer - simplified interface
(DoAfterSpecial) Adds a one-shot, temporary, timer to carry out some special action
(DoAfterSpeedWalk) Adds a one-shot, temporary speedwalk timer - simplified interface
(EnableTimer) Enables or disables an timer
(EnableTimerGroup) Enables/disables a group of timers
(GetPluginTimerOption) Gets the value of a named timer option for a specified plugin
(GetPluginTriggerOption) Gets the value of a named trigger option for a specified plugin
(GetTimer) Gets details about a timer
(GetTimerInfo) Gets details about a timer
(GetTimerList) Gets the list of timers
(GetTimerOption) Gets the value of a named timer option
(IsTimer) Tests to see if a timer exists
(ResetTimers) Resets all timers
(SetTimerOption) Sets the value of a named timer option
(Help topic: function=ResetTimer)