world.GetPluginList

MUSHclient script function (Method) — introduced in version 3.23

Gets a list of installed plugins.

Prototype

VARIANT GetPluginList();

Data type meanings

Description

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

VBscript example

dim pluginList 

pluginList = world.GetPluginList

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

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

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.

Related topic

Plugins

See also

FunctionDescription
CallPluginCalls a routine in a plugin
EnablePluginEnables or disables the specified plugin
GetPluginAliasListGets the list of aliases in a specified plugin
GetPluginInfoGets details about a specified plugin
GetPluginTimerListGets the list of timers in a specified plugin
GetPluginTriggerListGets the list of triggers in a specified plugin
GetPluginVariableListGets the list of variables in a specified plugin
IsPluginInstalledChecks to see if a particular plugin is installed
PluginSupportsChecks if a plugin supports a particular routine