EnableTimer
Script function

world.EnableTimer

DOC_scripting Read about scripting

Type

Method

Summary

Enables or disables an timer

Prototype

long EnableTimer(BSTR TimerName, BOOL Enabled);

DOC_data_types 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


DOC_errors View list of return code meanings

See Also ...

Topics

DOC_aliases Aliases
DOC_defaults Default triggers/aliases/timers/macros/colours
DOC_starting Getting started
DOC_group Groups
DOC_plugins Plugins
DOC_timers Timers
DOC_triggers Triggers

Functions

FNC_AddTimer AddTimer (Adds a timer)
FNC_DeleteTemporaryTimers DeleteTemporaryTimers (Deletes all temporary timers)
FNC_DeleteTimer DeleteTimer (Deletes a timer)
FNC_DeleteTimerGroup DeleteTimerGroup (Deletes a group of timers)
FNC_DoAfter DoAfter (Adds a one-shot, temporary timer - simplified interface)
FNC_DoAfterSpecial DoAfterSpecial (Adds a one-shot, temporary, timer to carry out some special action)
FNC_DoAfterSpeedWalk DoAfterSpeedWalk (Adds a one-shot, temporary speedwalk timer - simplified interface)
FNC_EnableTimerGroup EnableTimerGroup (Enables/disables a group of timers)
FNC_GetTimer GetTimer (Gets details about a timer)
FNC_GetTimerInfo GetTimerInfo (Gets details about a timer)
FNC_GetTimerList GetTimerList (Gets the list of timers)
FNC_GetTimerOption GetTimerOption (Gets the value of a named timer option)
FNC_IsTimer IsTimer (Tests to see if a timer exists)
FNC_ResetTimer ResetTimer (Resets a named timer)
FNC_ResetTimers ResetTimers (Resets all timers)
FNC_SetTimerOption SetTimerOption (Sets the value of a named timer option)

(Help topic: function=EnableTimer)

DOC_contents Documentation contents page