[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.LoadPlugin

Name LoadPlugin
Type Method
Summary Loads a plugin from disk
Prototype long LoadPlugin(BSTR FileName);

View list of data type meanings


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.

Note: Available in 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")
Returns 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

Introduced in version 3.23

See also ...

Function Description
GetPluginInfo Gets details about a specified plugin
GetPluginList Gets a list of installed plugins.
IsPluginInstalled Checks to see if a particular plugin is installed
ReloadPlugin Reloads an installed plugin

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.

Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes

Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes

View all functions


Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]