Script function

world.EnablePlugin

Type

Method

Summary

Enables or disables the specified plugin

Prototype

long EnablePlugin(BSTR PluginID, BOOL Enabled);

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

See Also ...

Topics

Aliases
Arrays
Plugins
Scripting
Timers
Triggers
Variables

Functions

(BroadcastPlugin) Broadcasts a message to all installed plugins
(CallPlugin) Calls a routine in a plugin
(GetPluginID) Returns the 24-character ID of the current plugin
(GetPluginInfo) Gets details about a specified plugin
(GetPluginList) Gets a list of installed plugins.
(GetPluginName) Returns the name of the current plugin
(GetPluginTimerInfo) Gets details about a named timer for a specified plugin
(GetPluginTimerList) Gets the list of timers in a specified plugin
(GetPluginVariable) Gets the contents of a variable belonging to a plugin
(GetPluginVariableList) Gets the list of variables in a specified plugin
(IsPluginInstalled) Checks to see if a particular plugin is installed
(LoadPlugin) Loads a plugin from disk
(PluginSupports) Checks if a plugin supports a particular routine
(ReloadPlugin) Reloads an installed plugin
(SaveState) Saves the state of the current plugin
(UnloadPlugin) Unloads an installed plugin

(Help topic: function=EnablePlugin)