GetPluginAliasList
Script function

world.GetPluginAliasList

DOC_scripting Read about scripting

Type

Method

Summary

Gets the list of aliases in a specified plugin

Prototype

VARIANT GetPluginAliasList(BSTR PluginID);

DOC_data_types View list of 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.



See Also ...

Topics

DOC_aliases Aliases
DOC_mapper Auto-mapper
DOC_defaults Default triggers/aliases/timers/macros/colours
DOC_starting Getting started
DOC_group Groups
DOC_keypad Keypad navigation
DOC_macros Macro keys
DOC_plugins Plugins
DOC_regexp Regular Expressions
DOC_speed_walking Speed walking
DOC_timers Timers
DOC_triggers Triggers

Functions

FNC_AddAlias AddAlias (Adds an alias)
FNC_DeleteAlias DeleteAlias (Deletes an alias)
FNC_DeleteAliasGroup DeleteAliasGroup (Deletes a group of aliases)
FNC_DeleteTemporaryAliases DeleteTemporaryAliases (Deletes all temporary aliases)
FNC_EnableAlias EnableAlias (Enables or disables an alias)
FNC_EnableAliasGroup EnableAliasGroup (Enables/disables a group of aliases)
FNC_GetAlias GetAlias (Gets details about an alias)
FNC_GetAliasInfo GetAliasInfo (Gets details about an alias)
FNC_GetAliasList GetAliasList (Gets the list of aliases)
FNC_GetAliasOption GetAliasOption (Gets the value of a named alias option)
FNC_GetAliasWildcard GetAliasWildcard (Returns the contents of the specified wildcard for the named alias)
FNC_GetPluginAliasInfo GetPluginAliasInfo (Gets details about a named alias for a specified plugin)
FNC_IsAlias IsAlias (Tests to see if an alias exists)
FNC_SetAliasOption SetAliasOption (Sets the value of a named alias option)

(Help topic: function=GetPluginAliasList)

DOC_contents Documentation contents page