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


Script function


Read about scripting




Gets a list of installed plugins.


VARIANT GetPluginList();

View list of data type meanings


Returns an array of the unique IDs of all the plugins currently installed.

Available in MUSHclient version 3.23 onwards.

VBscript example

dim pluginList 

pluginList = world.GetPluginList

If Not IsEmpty (pluginList) Then
  For Each p In pluginList 
     world.note p & " = " &  world.GetPluginInfo (p, 1)

End If

Jscript example

pluginlist = new VBArray(world.GetPluginList()).toArray();

if (pluginlist)  // if not empty
  for (i = 0; i < pluginlist.length; i++)
      world.note(pluginlist [i] + " = " + 
                 world.GetPluginInfo(pluginlist [i], 1));

PerlScript example

foreach $item (Win32::OLE::in ($world->GetPluginList))
   ($key, $value) = ($item, $world->GetPluginInfo ($item, 1));
   $world->note($key . " = " . $value) if (defined ($key));

Python example

pluginlist = world.GetPluginList
if (pluginlist):
  for p in pluginlist: world.Note (p + " = " +
                  world.GetPluginInfo(p, 1))

Lua example

for k, v in pairs (GetPluginList()) do 
  Note (v, " = ", GetPluginInfo(v, 1))

Return value

If there are no plugins then the return value is empty. Use "IsEmpty" to test for this possibility.

Otherwise, it returns a variant array containing the unique IDs of all the plugins. Use "lbound" and "ubound" to find the bounds of the array of plugins (ie. the number of plugins in the list). You can then use "GetPluginInfo" to find information about each plugin.

See Also ...




(BroadcastPlugin) Broadcasts a message to all installed plugins
(CallPlugin) Calls a routine in a plugin
(EnablePlugin) Enables or disables the specified plugin
(GetPluginAliasList) Gets the list of aliases in a specified plugin
(GetPluginID) Returns the 24-character ID of the current plugin
(GetPluginInfo) Gets details about a specified plugin
(GetPluginName) Returns the name of the current plugin
(GetPluginTimerInfo) Gets details about a named timer for a specified plugin
(GetPluginTimerList) Gets the list of timers in a specified plugin
(GetPluginTriggerList) Gets the list of triggers in a specified plugin
(GetPluginVariable) Gets the contents of a variable belonging to a plugin
(GetPluginVariableList) Gets the list of variables in a specified plugin
(IsPluginInstalled) Checks to see if a particular plugin is installed
(LoadPlugin) Loads a plugin from disk
(PluginSupports) Checks if a plugin supports a particular routine
(ReloadPlugin) Reloads an installed plugin
(SaveState) Saves the state of the current plugin
(UnloadPlugin) Unloads an installed plugin

(Help topic: function=GetPluginList)

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]