world.EnablePlugin

MUSHclient script function (Method)

Enables or disables the specified plugin

Prototype

long EnablePlugin(BSTR PluginID, BOOL Enabled);

Data type meanings

Description

Enables or disables the named plugin. An enabled plugin is "active", otherwise its triggers, timers and aliases are ignored.

You can use GetPluginInfo to see if the plugin is currently enabled.

If the plugin's "enabled" state changes (ie. from enabled to disabled, or disabled to enabled) then the appropriate routine in the plugin is called, if found ...

OnPluginEnable or OnPluginDisable

For example, you might have these routines in your plugin ...

sub OnPluginEnable
world.Note world.GetPluginName & " has just been enabled."
end sub

sub OnPluginDisable
world.Note world.GetPluginName & " has just been disabled."
end sub

VBscript example

world.EnablePlugin "982581e59ab42844527eec80", vbTrue

Jscript example

world.EnablePlugin ("982581e59ab42844527eec80", true);

PerlScript example

$world->EnablePlugin ("982581e59ab42844527eec80", 1);

Python example

world.EnablePlugin ("982581e59ab42844527eec80", True)

Lua example

EnablePlugin ("982581e59ab42844527eec80", true)

Lua notes

The enabled flag is optional, and defaults to true.

Return value

eNoSuchPlugin: That plugin ID is not installed
eOK: enabled/disabled OK

Return code meanings

Related topic

Plugins

See also