Script function
world.DeleteAliasGroup
Read about scripting
Type
Method
Summary
Deletes a group of aliases
Prototype
long DeleteAliasGroup(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 aliases do this:
world.DeleteAliasGroup "groupname"
For debugging purposes the function returns a count of the number of members deleted. eg.
dim mycount
mycount = world.DeleteAliasGroup ("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 alias is executing a script it cannot be deleted. For example, an alias cannot delete itself.
If you need to delete an alias from within itself use DoAfterSpecial to delete it after a short delay. You might also want to use EnableAliasGroup to disable it first.
Since DeleteAliasGroup deletes multiple aliases, any found to be "in use" (that is, executing a script) will not be deleted.
Available in MUSHclient version 3.29 onwards.
VBscript example
world.DeleteAliasGroup "groupname"
Jscript example
world.DeleteAliasGroup ("groupname");
PerlScript example
$world->DeleteAliasGroup ("groupname");
Python example
world.DeleteAliasGroup ("groupname")
Lua example
DeleteAliasGroup ("groupname")
Return value
A count of the number of items deleted.
See Also ...
Topics
Aliases
Auto-mapper
Default triggers/aliases/timers/macros/colours
Getting started
Groups
Keypad navigation
Macro keys
Plugins
Regular Expressions
Speed walking
Timers
Triggers
Functions
(AddAlias) Adds an alias
(DeleteAlias) Deletes an alias
(DeleteGroup) Deletes a group of triggers, aliases and timers
(DeleteTemporaryAliases) Deletes all temporary aliases
(DeleteTimerGroup) Deletes a group of timers
(DeleteTriggerGroup) Deletes a group of triggers
(DoAfterSpecial) Adds a one-shot, temporary, timer to carry out some special action
(EnableAlias) Enables or disables an alias
(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
(GetAlias) Gets details about an alias
(GetAliasInfo) Gets details about an alias
(GetAliasList) Gets the list of aliases
(GetAliasOption) Gets the value of a named alias option
(GetAliasWildcard) Returns the contents of the specified wildcard for the named alias
(GetPluginAliasInfo) Gets details about a named alias for a specified plugin
(GetPluginAliasList) Gets the list of aliases in a specified plugin
(GetPluginAliasOption) Gets the value of a named alias option for a specified plugin
(GetTimerInfo) Gets details about a timer
(GetTriggerInfo) Gets details about a named trigger
(IsAlias) Tests to see if an alias exists
(SetAliasOption) Sets the value of a named alias option
(Help topic: function=DeleteAliasGroup)