Script function
world.EnableGroup
Read about scripting
Type
Method
Summary
Enables/disables a group of triggers, aliases and timers
Prototype
long EnableGroup(BSTR GroupName, BOOL Enabled);
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 enable an entire group of triggers, aliases and timers do this:
world.EnableGroup "groupname", 1
To disable the entire group:
world.EnableGroup "groupname", 0
For debugging purposes the function returns a count of the number of members in the group (not the number enabled, as some may already be enabled). eg.
dim mycount
mycount = world.EnableGroup ("groupname", 1)
If you are using plugins only the members of the current plugin (if any) are affected. If the call is made outside a plugin only the members of the group that are not in a plugin are affected.
Available in MUSHclient version 3.27 onwards.
VBscript example
world.EnableGroup "groupname", 1 ' enable the group
world.EnableGroup "groupname", 0 ' disable the group
Jscript example
world.EnableGroup ("groupname", 1); // enable the group
world.EnableGroup ("groupname", 0); // disable the group
PerlScript example
$world->EnableGroup ("groupname", 1); # enable the group
$world->EnableGroup ("groupname", 0); # disable the group
Python example
world.EnableGroup ("groupname", 1) # enable the group
world.EnableGroup ("groupname", 0) # disable the group
Lua example
EnableGroup ("groupname", true) -- enable the group
EnableGroup ("groupname", false) -- disable the group
Lua notes
The enabled flag is optional, and defaults to true.
Return value
A count of the number of items in that group.
See Also ...
Topics
Aliases
Groups
Timers
Triggers
Functions
(DeleteAliasGroup) Deletes a group of aliases
(DeleteGroup) Deletes a group of triggers, aliases and timers
(DeleteTimerGroup) Deletes a group of timers
(DeleteTriggerGroup) Deletes a group of triggers
(EnableAliasGroup) Enables/disables a group of aliases
(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
(Help topic: function=EnableGroup)