Description of MUSHclient world function: world.GetPluginAliasList
Name | GetPluginAliasList |
---|---|
Type | Method |
Summary | Gets the list of aliases in a specified plugin |
Prototype | VARIANT GetPluginAliasList(BSTR PluginID);
|
Description | Returns an array of all the named aliases currently defined for the nominated plugin. You can then use GetPluginAliasInfo to find out more details about each one. Note: Available in version 3.23 onwards. |
VBscript example |
|
Jscript example |
|
PerlScript example |
|
Python example |
|
Lua example |
|
Returns | If there are no aliases (with names) then the return value is empty. Use "IsEmpty" to test for this possibility. |
Introduced in version | 3.23 |
See also ...
Function | Description |
---|---|
AddAlias | Adds an alias |
DeleteAlias | Deletes an alias |
EnableAlias | Enables or disables an alias |
GetAlias | Gets details about an alias |
GetAliasInfo | Gets details about an alias |
GetAliasList | Gets the list of aliases |
GetPluginAliasInfo | Gets details about a named alias for a specified plugin |
IsAlias | Tests to see if an alias exists |
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.
Many functions return a "code" which indicates the success or otherwise of the function.
You can view a list of the return codes
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
Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.