MUSHclient scripting

Description of MUSHclient world function: world.GetPluginAliasInfo

Name	GetPluginAliasInfo
Type	Method
Summary	Gets details about a named alias for a specified plugin
Prototype	`VARIANT GetPluginAliasInfo(BSTR PluginID, BSTR AliasName, short InfoType);` View list of data type meanings
Description	Gets details about the specified alias for the specified plugin. You can obtain various "types" of information about the alias by specifying an "InfoType". The possible InfoTypes are described under GetAliasInfo. If the named alias does not exist, EMPTY is returned. If the name given is invalid, NULL is returned. If the InfoType given is out of range, NULL is returned. If the plugin does not exist, NULL is returned. (Use "IsEmpty" and "IsNull" to test for these possibilities). If you want to find the value of a alias in the current plugin, use "GetAliasInfo". If you are writing a plugin and want to find "global" MUSHclient alias values, use an empty plugin ID, eg. world.Note world.GetPluginAliasInfo ("", "my_alias", 1) Note: Available in version 3.23 onwards.
VBscript example	`world.note world.GetPluginAliasInfo ("c8efc9f9e1edd118c6f2dbf5", "my_alias", 2)`
Jscript example	`world.note(world.GetPluginAliasInfo ("c8efc9f9e1edd118c6f2dbf5", "my_alias", 2));`
PerlScript example	`/$world->note ($world->GetPluginAliasInfo ("c8efc9f9e1edd118c6f2dbf5", "my_alias", 2));`
Python example	`world.note(world.GetPluginAliasInfo ("c8efc9f9e1edd118c6f2dbf5", "my_alias", 2))`
Lua example	`Note (GetPluginAliasInfo ("c8efc9f9e1edd118c6f2dbf5", "my_alias", 2))`
Lua notes	`Lua returns nil where applicable instead of an "empty variant" or "null variant".`
Returns	`The specified information about the alias, as described above. An EMPTY variant, if the alias does not exist. A NULL variant if the alias name is invalid. A NULL variant if the InfoType is not a valid type. A NULL variant if the plugin is not installed.`
Introduced in version	3.23

See also ...

Function	Description
AddAlias	Adds an alias
DeleteAlias	Deletes an alias
GetAliasInfo	Gets details about an alias
GetAliasList	Gets the list of aliases
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.

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

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.