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


Script function


Read about scripting




Gets the list of aliases in a specified plugin


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

Available in MUSHclient 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) 

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.

See Also ...


Default triggers/aliases/timers/macros/colours
Getting started
Keypad navigation
Macro keys
Regular Expressions
Speed walking


(AddAlias) Adds an alias
(DeleteAlias) Deletes an alias
(DeleteAliasGroup) Deletes a group of aliases
(DeleteTemporaryAliases) Deletes all temporary aliases
(EnableAlias) Enables or disables an alias
(EnableAliasGroup) Enables/disables a group of aliases
(GetAlias) Gets details about an alias
(GetAliasInfo) Gets details about an alias
(GetAliasList) Gets the list of aliases
(GetAliasOption) Gets the value of a named alias option
(GetAliasWildcard) Returns the contents of the specified wildcard for the named alias
(GetPluginAliasInfo) Gets details about a named alias for a specified plugin
(GetPluginAliasOption) Gets the value of a named alias option for a specified plugin
(IsAlias) Tests to see if an alias exists
(SetAliasOption) Sets the value of a named alias option

(Help topic: function=GetPluginAliasList)

Documentation contents page

Search ...

Enter a search string to find matching documentation.

Search for:   

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]