world.GetPluginAliasList

MUSHclient script function (Method) — introduced in version 3.23

Gets the list of aliases in a specified plugin

Prototype

VARIANT GetPluginAliasList(BSTR PluginID);

Data type meanings

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.

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 ("")

VBscript example

dim alList

alList = world.GetPluginAliasList ("982581e59ab42844527eec80")

If Not IsEmpty (alList) Then
  for each a in alList
    world.note a
  next
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")))
 {
 $world->note($item);
 }

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

Return value

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.

Related topic

Aliases

See also