Script function
world.LoadPlugin
Read about scripting
Type
Method
Summary
Loads a plugin from disk
Prototype
long LoadPlugin(BSTR FileName);
View list of data type meanings
Description
Loads a plugin file from disk. This is intended to let plugins load other plugins if desired. For example, you could make a "scan plugin directory" plugin, that loads all plugins found in a particular directory.
You might use "IsPluginInstalled" to see if a particular plugin is already installed.
If the plugin cannot be loaded an error window will open describing the problem with the plugin (eg. XML parsing error).
However if the problem is simply that the plugin file cannot be found, then no window will open.
You can use ReloadPlugin to reinstall a plugin once it is loaded, if you have changed it.
Available in MUSHclient version 3.23 onwards.
VBscript example
LoadPlugin "c:/mushclient/plugins/plugin_list.xml"
Jscript example
LoadPlugin ("c:/mushclient/plugins/plugin_list.xml");
PerlScript example
$world->LoadPlugin ("c:/mushclient/plugins/plugin_list.xml");
Python example
world.LoadPlugin ("c:/mushclient/plugins/plugin_list.xml")
Lua example
LoadPlugin ("c:/mushclient/plugins/plugin_list.xml")
Return value
ePluginFileNotFound: Plugin file not found
eProblemsLoadingPlugin: Parsing or other problem in plugin file - see error window
eOK: Loaded OK
View list of return code meanings
See Also ...
Topics
Aliases
Arrays
Plugins
Scripting
Timers
Triggers
Variables
Functions
(BroadcastPlugin) Broadcasts a message to all installed plugins
(CallPlugin) Calls a routine in a plugin
(EnablePlugin) Enables or disables the specified plugin
(GetPluginID) Returns the 24-character ID of the current plugin
(GetPluginInfo) Gets details about a specified plugin
(GetPluginList) Gets a list of installed plugins.
(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
(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
(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=LoadPlugin)