world.EnableAliasGroup

MUSHclient script function (Method) — introduced in version 3.27

Enables/disables a group of aliases

Prototype

long EnableAliasGroup(BSTR GroupName, BOOL Enabled);

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 aliases do this:

world.EnableAliasGroup "groupname", 1

To disable the entire group:

world.EnableAliasGroup "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.EnableAliasGroup ("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.

VBscript example

world.EnableAliasGroup "groupname", 1  ' enable the group
world.EnableAliasGroup "groupname", 0  ' disable the group

Jscript example

world.EnableAliasGroup ("groupname", 1);  // enable the group
world.EnableAliasGroup ("groupname", 0);  // disable the group

PerlScript example

$world->EnableAliasGroup ("groupname", 1);  # enable the group
$world->EnableAliasGroup ("groupname", 0);  # disable the group

Python example

world.EnableAliasGroup ("groupname", 1)  # enable the group
world.EnableAliasGroup ("groupname", 0)  # disable the group

Lua example

EnableAliasGroup ("groupname", true)  -- enable the group
EnableAliasGroup ("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.

Related topic

Aliases

See also