Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.UnloadPlugin

Name UnloadPlugin
Type Method
Summary Unloads an installed plugin
Prototype long UnloadPlugin(BSTR PluginID);

View list of data type meanings
Description

Unloads (removes from MUSHclient world space) the specified plugin.

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 unload 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 unloads plugin A, you will probably get a crash. If you really want to make a "unload myself" function in a plugin, use something like DoAfterSpecial, to send the "UnloadPlugin" command to the script engine after a 1-second delay.

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

Note: Available in version 4.73 onwards.
VBscript example 
UnloadPlugin "chat"
UnloadPlugin "753ba7e011f3c8943a885f18"
Jscript example 
world.UnloadPlugin ("chat");
world.UnloadPlugin ("753ba7e011f3c8943a885f18");
PerlScript example 
$world->UnloadPlugin ("chat");
$world->UnloadPlugin ("753ba7e011f3c8943a885f18");
Python example 
world.UnloadPlugin ("chat")
world.UnloadPlugin ("753ba7e011f3c8943a885f18")
Lua example 
UnloadPlugin ("chat")
UnloadPlugin ("753ba7e011f3c8943a885f18")
Returns eNoSuchPlugin: Plugin is not currently installed
eBadParameter: Cannot unload ourselves
eOK: Unloaded OK

View list of return code meanings
Introduced in version 4.73

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
LoadPlugin Loads a plugin from disk
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

[Back]

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

Home