DeleteTimer
Script function world.DeleteTimer Read about scripting Type Method Summary Deletes a timer Prototype `long DeleteTimer(BSTR TimerName);` View list of data type meanings Description `Deletes the named timer from the list of timers. WARNING - if the timer is executing a script it cannot be deleted. For example, a timer cannot delete itself. If you need to delete a timer from within itself use DoAfterSpecial to delete it after a short delay. You might also want to use EnableTimer to disable it first.` VBscript example
    world.DeleteTimer "mytimer"
Jscript example
    world.DeleteTimer("mytimer");
PerlScript example
    $world->DeleteTimer("mytimer");
Python example
    world.DeleteTimer("mytimer")
Lua example
    DeleteTimer("mytimer")
Return value
    eInvalidObjectLabel: The timer name is not valid
    eTimerNotFound: The named timer does not exist
    eItemInUse: Cannot delete trigger/alias/timer because it is executing a script
    eOK: deleted 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) 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) 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=DeleteTimer) Documentation contents page