Read about scripting
Deletes a group of timers
View list of data type meanings
long DeleteTimerGroup(BSTR GroupName);
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:
For debugging purposes the function returns a count of the number of members deleted. eg.
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.
Available in MUSHclient version 3.29 onwards.
A count of the number of items deleted.
See Also ...
(AddTimer) Adds a timer
(DeleteAliasGroup) Deletes a group of aliases
(DeleteGroup) Deletes a group of triggers, aliases and timers
(DeleteTemporaryTimers) Deletes all temporary timers
(DeleteTimer) Deletes a timer
(DeleteTriggerGroup) Deletes a group of triggers
(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
(EnableAliasGroup) Enables/disables a group of aliases
(EnableGroup) Enables/disables a group of triggers, aliases and timers
(EnableTimer) Enables or disables an timer
(EnableTimerGroup) Enables/disables a group of timers
(EnableTriggerGroup) Enables/disables a group of triggers
(GetAliasInfo) Gets details about an alias
(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
(GetTriggerInfo) Gets details about a named trigger
(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=DeleteTimerGroup)