Name GetPluginInfo
Type Method
Summary Gets details about a specified plugin
Prototype VARIANT GetPluginInfo(BSTR PluginID, short InfoType);
Description Gets details about the specified plugin, identified by its unique ID.

You can obtain various "types" of information about the plugin by specifying an "InfoType".

If the InfoType given is out of range, NULL is returned. If the plugin does not exist, NULL is returned. (Use "IsNull" to test for this possibility).

You can obtain one of 18 "types" of information about the plugin by specifying an "InfoType". The possible InfoTypes are:

1: Name (string)
2: Author (string)
3: Description (long description) (string)
4: Script contents (string)
5: Script language (ie. vbscript, perlscript, jscript) (string)
6: Plugin file name (string)
7: Unique ID (string)
8: Purpose (short description) (string)
9: Number of triggers (long)
10: Number of aliases (long)
11: Number of timers (long)
12: Number of variables (long)
13: Date written (date)
14: Date modified (date)
15: Save state flag (boolean)
16: Scripting enabled? (boolean)
17: Enabled? (boolean)
18: Required MUSHclient version (double)
19: Version of plugin (double)

Note: Available in MUSHclient version 3.23 onwards.
VBscript example
world.note world.GetPluginInfo (world.GetPluginID, 8)
Jscript example
world.note (world.GetPluginInfo (world.GetPluginID, 8));
PerlScript example
$world->note ($world->GetPluginInfo ($world->GetPluginID, 8));
Returns The specified information about the plugin, as described above.
A NULL variant if the InfoType is not a valid type.
A NULL variant if the plugin is not installed.

See also ...