world.GetPluginAliasOption

MUSHclient script function (Method) — introduced in version 4.21

Gets the value of a named alias option for a specified plugin

Prototype

VARIANT GetPluginAliasOption(BSTR PluginID, BSTR AliasName, BSTR OptionName);

Data type meanings

Description

Gets the current value of an alias option for the specified plugin.

You must specify a plugin ID, the name of an existing alias, and an alias option from the list given under the description for GetAliasOption. These are the same names as used in the XML world files for alias options.

If you want to find the value of an alias option in the current plugin, use "GetAliasOption".

If you are writing a plugin and want to find "global" MUSHclient alias values, use an empty plugin ID, eg.

world.Note world.GetPluginAliasOption ("", "my_alias", "enabled")

If the option name is not known, or is not allowed to be retrieved, a NULL variant is returned.

If the named alias does not exist, EMPTY is returned. If the name given is invalid, NULL is returned. If the option name is not known, EMPTY is returned. (Use "IsEmpty" and "IsNull" to test for these possibilities).

See GetAliasOption for a list of option names and values.

VBscript example

Note GetPluginAliasOption("c8efc9f9e1edd118c6f2dbf5", "my_alias", "match")

Jscript example

Note (GetPluginAliasOption ("c8efc9f9e1edd118c6f2dbf5", "my_alias", "match"));

PerlScript example

/$world->Note ($world->GetPluginAliasOption ("c8efc9f9e1edd118c6f2dbf5", "my_alias", "match"));

Python example

world.Note(world.GetPluginAliasOption ("c8efc9f9e1edd118c6f2dbf5", "my_alias", "match"))

Lua example

Note (GetPluginAliasOption ("c8efc9f9e1edd118c6f2dbf5", "my_alias", "match"))

Lua notes

Lua returns nil where applicable instead of an "empty variant" or "null variant".

Return value

As described above.

Related topic

Aliases

See also