EnablePlugin
Script function

world.EnablePlugin

DOC_scripting Read about scripting

Type

Method

Summary

Enables or disables the specified plugin

Prototype

long EnablePlugin(BSTR PluginID, BOOL Enabled);

DOC_data_types View list of 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


DOC_errors View list of return code meanings

See Also ...

Topics

DOC_aliases Aliases
DOC_Arrays Arrays
DOC_plugins Plugins
DOC_scripting Scripting
DOC_timers Timers
DOC_triggers Triggers
DOC_variables Variables

Functions

FNC_BroadcastPlugin BroadcastPlugin (Broadcasts a message to all installed plugins)
FNC_CallPlugin CallPlugin (Calls a routine in a plugin)
FNC_GetPluginID GetPluginID (Returns the 24-character ID of the current plugin)
FNC_GetPluginInfo GetPluginInfo (Gets details about a specified plugin)
FNC_GetPluginList GetPluginList (Gets a list of installed plugins.)
FNC_GetPluginName GetPluginName (Returns the name of the current plugin)
FNC_GetPluginTimerInfo GetPluginTimerInfo (Gets details about a named timer for a specified plugin)
FNC_GetPluginTimerList GetPluginTimerList (Gets the list of timers in a specified plugin)
FNC_GetPluginVariable GetPluginVariable (Gets the contents of a variable belonging to a plugin)
FNC_GetPluginVariableList GetPluginVariableList (Gets the list of variables in a specified plugin)
FNC_IsPluginInstalled IsPluginInstalled (Checks to see if a particular plugin is installed)
FNC_LoadPlugin LoadPlugin (Loads a plugin from disk)
FNC_PluginSupports PluginSupports (Checks if a plugin supports a particular routine)
FNC_ReloadPlugin ReloadPlugin (Reloads an installed plugin)
FNC_SaveState SaveState (Saves the state of the current plugin)

(Help topic: function=EnablePlugin)

DOC_contents Documentation contents page