world.ReloadPlugin

MUSHclient script function (Method) — introduced in version 3.50

Reloads an installed plugin

Prototype

long ReloadPlugin(BSTR PluginID);

Data type meanings

Description

This is designed to help plugin writers quickly reload a plugin they are testing. You can specify the plugin by unique ID, or by plugin name (assuming the name is unique in your list of plugins).

eg.

world.ReloadPlugin "chat"
world.ReloadPlugin "753ba7e011f3c8943a885f18"

However, a plugin cannot reload itself. That would mean the script was deleted out from under itself. If you try to work around that by having plugin A call plugin B, and plugin B reloads plugin A, you will probably get a crash. If you really want to make a "reload myself" function in a plugin, use something like DoAfterSpecial, to send the "ReloadPlugin" command to the script engine after a 1-second delay.

The intention here is for plugin authors to make an alias that they can type when they want to retest their plugin.

The check for plugin name or plugin ID is not case-sensitive.

VBscript example

world.ReloadPlugin "chat"
world.ReloadPlugin "753ba7e011f3c8943a885f18"

Jscript example

world.ReloadPlugin ("chat");
world.ReloadPlugin ("753ba7e011f3c8943a885f18");

PerlScript example

$world->ReloadPlugin ("chat");
$world->ReloadPlugin ("753ba7e011f3c8943a885f18");

Python example

world.ReloadPlugin ("chat")
world.ReloadPlugin ("753ba7e011f3c8943a885f18")

Lua example

ReloadPlugin ("chat")
ReloadPlugin ("753ba7e011f3c8943a885f18")

Return value

eNoSuchPlugin: Plugin is not currently installed
eBadParameter: Cannot reload ourselves
ePluginFileNotFound: Plugin file not found
eProblemsLoadingPlugin: Parsing or other problem in plugin file - see error window
eOK: Loaded OK

Return code meanings

Related topic

Plugins

See also