world.DeleteTimerGroup

MUSHclient script function (Method) — introduced in version 3.29

Deletes a group of timers

Prototype

long DeleteTimerGroup(BSTR GroupName);

Data type meanings

Description

Triggers, aliases and timers can be placed in "groups" where a group is a bunch of related items. Groups have names, there is no restriction on the name of a group. Ungrouped items have blank (empty) names.

To delete an entire group of timers do this:

world.DeleteTimerGroup "groupname"

For debugging purposes the function returns a count of the number of members deleted. eg.

dim mycount
mycount = world.DeleteTimerGroup ("groupname")

If you are using plugins only the members of the current plugin (if any) are deleted. If the call is made outside a plugin only the members of the group that are not in a plugin are deleted.

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 EnableTimerGroup to disable it first.

Since DeleteTimerGroup deletes multiple timers, any found to be "in use" (that is, executing a script) will not be deleted.

VBscript example

world.DeleteTimerGroup "groupname"

Jscript example

world.DeleteTimerGroup ("groupname");

PerlScript example

$world->DeleteTimerGroup ("groupname");

Python example

world.DeleteTimerGroup ("groupname")

Lua example

DeleteTimerGroup ("groupname")

Return value

A count of the number of items deleted.

Related topic

Timers

See also