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

MUSHclient scripting

Description of MUSHclient world function: world.GetPluginAliasOption


Name GetPluginAliasOption
Type Method
Summary Gets the value of a named alias option for a specified plugin
Prototype VARIANT GetPluginAliasOption(BSTR PluginID, BSTR AliasName, BSTR OptionName);

View list of 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.


Note: Available in version 4.21 onwards.


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".
Returns As described above.
Introduced in version 4.21

See also ...

Function Description
AddAlias Adds an alias
DeleteAlias Deletes an alias
GetAliasInfo Gets details about an alias
GetAliasList Gets the list of aliases
GetAliasOption Gets the value of a named alias option
GetPluginAliasList Gets the list of aliases in a specified plugin

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]