Plugins
Plugins are self-contained collections of related triggers, aliases, timers, variables and script routines. They are distributed as a single file, and installed by simply clicking on 'add' in the plugins dialog.

They are intended to allow the distribution of extensions to MUSHclient functionality in a simple way, without having to have complex instructions about amending script files, adding triggers and so on.

Plugins can also save their 'state' (ie. remember variables) so that variables that are set in one session will be remembered in another. This happens on a per-plugin, per-world basis.

You can quickly generate your own plugins by using the Plugin Wizard, which creates a plugin from your existing triggers, timers, aliases, variables and scripts.

See Also ...

Topics

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

Commands

CMD_ID_FILE_PLUGINS Plugins (Shows plugins active for this world)
CMD_ID_FILE_PLUGINWIZARD PluginWizard (Invokes the plugin creation wizard)

Dialogs

DLG_IDD_GLOBAL_PREFSP12 Global preferences - plugins
DLG_IDD_PLUGINWIZARDPAGE4 Plugin wizard - Aliases
DLG_IDD_PLUGINWIZARDPAGE8 Plugin wizard - Comments
DLG_IDD_PLUGINWIZARDPAGE2 Plugin wizard - Description
DLG_IDD_PLUGINWIZARDPAGE1 Plugin wizard - Name and Purpose
DLG_IDD_PLUGINWIZARDPAGE7 Plugin wizard - Script
DLG_IDD_PLUGINWIZARDPAGE5 Plugin wizard - Timers
DLG_IDD_PLUGINWIZARDPAGE3 Plugin wizard - Triggers
DLG_IDD_PLUGINWIZARDPAGE6 Plugin wizard - Variables
DLG_IDD_PLUGINS Plugins

Functions

FNC_BroadcastPlugin BroadcastPlugin (Broadcasts a message to all installed plugins)
FNC_CallPlugin CallPlugin (Calls a routine in a plugin)
FNC_EnablePlugin EnablePlugin (Enables or disables the specified 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: general=plugins)

DOC_contents Documentation contents page