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

MUSHclient scripting

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);

View list of data type meanings


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.

If you want to find the list of aliases in the current plugin, use "GetAliasList".

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

alList = world.GetPluginAliasList ("")

Note: Available in version 3.23 onwards.

VBscript example
dim alList

alList = world.GetPluginAliasList ("982581e59ab42844527eec80")

If Not IsEmpty (alList) Then
  for each a in alList
    world.note a
End If
Jscript example
aliaslist = new VBArray(world.GetPluginAliasList("982581e59ab42844527eec80")).toArray();

if (aliaslist)  // if not empty
 for (i = 0; i < aliaslist.length; i++)
   world.note(aliaslist [i]);
PerlScript example
foreach $item (Win32::OLE::in ($world->GetPluginAliasList ("982581e59ab42844527eec80")))
Python example
aliaslist = world.GetPluginAliasList ("982581e59ab42844527eec80")
if (aliaslist):
  for a in aliaslist : world.Note (a)
Lua example
for k, v in pairs (GetPluginAliasList ("982581e59ab42844527eec80")) do 
  Note (v) 
Returns If there are no aliases (with names) then the return value is empty. Use "IsEmpty" to test for this possibility.

If the nominated plugin does not exist, then the return value is NULL. Use "IsNull" to test for this possibility.

Otherwise, it returns a variant array containing the names of all the aliases in the specified plugin. Use "ubound" to find the number of aliases in the list. You can then use "GetPluginAliasInfo" to find details about each alias.
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

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


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.


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]