world.DeleteTimer

MUSHclient script function (Method)

Deletes a timer

Prototype

long DeleteTimer(BSTR TimerName);

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

Return code meanings

Related topic

Timers

See also