[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.EnablePlugin


Name EnablePlugin
Type Method
Summary Enables or disables the specified plugin
Prototype long EnablePlugin(BSTR PluginID, BOOL Enabled);

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.
Returns eNoSuchPlugin: That plugin ID is not installed
eOK: enabled/disabled OK

View list of return code meanings


See also ...

Function Description
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.

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]

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

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

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]