GetPluginList
Script function

world.GetPluginList

DOC_scripting Read about scripting

Type

Method

Summary

Gets a list of installed plugins.

Prototype

VARIANT GetPluginList();

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



See Also ...

Topics

DOC_aliases Aliases
DOC_Arrays Arrays
DOC_plugins Plugins
DOC_scripting Scripting
DOC_timers Timers
DOC_triggers Triggers
DOC_variables Variables

Functions

FNC_BroadcastPlugin BroadcastPlugin (Broadcasts a message to all installed plugins)
FNC_CallPlugin CallPlugin (Calls a routine in a plugin)
FNC_EnablePlugin EnablePlugin (Enables or disables the specified plugin)
FNC_GetPluginAliasList GetPluginAliasList (Gets the list of aliases in a specified plugin)
FNC_GetPluginID GetPluginID (Returns the 24-character ID of the current plugin)
FNC_GetPluginInfo GetPluginInfo (Gets details about a specified plugin)
FNC_GetPluginName GetPluginName (Returns the name of the current plugin)
FNC_GetPluginTimerInfo GetPluginTimerInfo (Gets details about a named timer for a specified plugin)
FNC_GetPluginTimerList GetPluginTimerList (Gets the list of timers in a specified plugin)
FNC_GetPluginTriggerList GetPluginTriggerList (Gets the list of triggers in a specified plugin)
FNC_GetPluginVariable GetPluginVariable (Gets the contents of a variable belonging to a plugin)
FNC_GetPluginVariableList GetPluginVariableList (Gets the list of variables in a specified plugin)
FNC_IsPluginInstalled IsPluginInstalled (Checks to see if a particular plugin is installed)
FNC_LoadPlugin LoadPlugin (Loads a plugin from disk)
FNC_PluginSupports PluginSupports (Checks if a plugin supports a particular routine)
FNC_ReloadPlugin ReloadPlugin (Reloads an installed plugin)
FNC_SaveState SaveState (Saves the state of the current plugin)

(Help topic: function=GetPluginList)

DOC_contents Documentation contents page