[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.DeleteTimerGroup


Name DeleteTimerGroup
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.


Note: Available in version 3.29 onwards.


VBscript example
world.DeleteTimerGroup "groupname"
Jscript example
world.DeleteTimerGroup ("groupname");
PerlScript example
$world->DeleteTimerGroup ("groupname");
Python example
world.DeleteTimerGroup ("groupname")
Lua example
DeleteTimerGroup ("groupname")
Returns A count of the number of items deleted.
Introduced in version 3.29

See also ...

Function Description
DeleteAliasGroup Deletes a group of aliases
DeleteGroup Deletes a group of triggers, aliases and timers
DeleteTimer Deletes a timer
DeleteTriggerGroup Deletes a group of triggers
EnableAliasGroup Enables/disables a group of aliases
EnableGroup Enables/disables a group of triggers, aliases and timers
EnableTimerGroup Enables/disables a group of timers
EnableTriggerGroup Enables/disables a group of triggers
GetAliasInfo Gets details about an alias
GetTimerInfo Gets details about a timer
GetTriggerInfo Gets details about a named trigger

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.


Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes


Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes


View all functions

[Back]

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]