DeleteTimerGroup
Script function world.DeleteTimerGroup Read about scripting Type Method Summary Deletes a group of timers Prototype `long DeleteTimerGroup(BSTR GroupName);` View list of 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.
See Also ... Topics Aliases Default triggers/aliases/timers/macros/colours Getting started Groups Plugins Timers Triggers Functions 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) 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) Documentation contents page