LoadPlugin
Script function

world.LoadPlugin

DOC_scripting Read about scripting

Type

Method

Summary

Loads a plugin from disk

Prototype

long LoadPlugin(BSTR FileName);

DOC_data_types 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.

VBscript example

world.loadplugin "c:mushclientpluginsplugin_list.xml"


Jscript example

world.loadplugin ("c:mushclientpluginsplugin_list.xml");


PerlScript example

$world->loadplugin ("c:mushclientpluginsplugin_list.xml");


Python example

world.loadplugin ("c:mushclientpluginsplugin_list.xml")


Lua example

LoadPlugin ("c:mushclientpluginsplugin_list.xml")


Return value

ePluginFileNotFound: Plugin file not found
eProblemsLoadingPlugin: Parsing or other problem in plugin file - see error window
eOK: Loaded OK


DOC_errors View list of return code meanings

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_GetPluginID GetPluginID (Returns the 24-character ID of the current plugin)
FNC_GetPluginInfo GetPluginInfo (Gets details about a specified plugin)
FNC_GetPluginList GetPluginList (Gets a list of installed plugins.)
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_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_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=LoadPlugin)

DOC_contents Documentation contents page