Script function
world.EnableTimer
Read about scripting
Type
Method
Summary
Enables or disables an timer
Prototype
long EnableTimer(BSTR TimerName, BOOL Enabled);
View list of data type meanings
Description
Enables or disables the named timer. An enabled timer is "active", otherwise it is ignored when processing periodic events.
VBscript example
world.EnableTimer "heartbeat", TRUE
Jscript example
world.EnableTimer("heartbeat", true);
PerlScript example
$world->EnableTimer("heartbeat", true);
Python example
world.EnableTimer("heartbeat", True)
Lua example
EnableTimer("heartbeat", true)
Lua notes
The enabled flag is optional, and defaults to true.
Return value
eInvalidObjectLabel: The timer name is not valid
eTimerNotFound: The named timer does not exist
eOK: completed 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
(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
(ResetTimer) Resets a named timer
(ResetTimers) Resets all timers
(SetTimerOption) Sets the value of a named timer option
(Help topic: function=EnableTimer)