Plugin

A Plugin represents a modular, extendable class that encapsulates certain Bot functionality into a logical slice. Plugins usually have a set of commands and listeners attached to them, and are built to be dynamically loaded/reloaded into a Bot.

class Plugin {

Bot bot;

PluginState state;

string dynamicLibraryPath;

DynamicLibrary dynamicLibrary;

this(PluginOptions opts = null);

Logger log [@property getter];

void load(Bot bot, PluginState state = null);

void unload(Bot bot);

string storageDirectoryPath [@property getter];

string storagePath [@property getter];

string configPath [@property getter];

Storage storage [@property getter];

Storage config [@property getter];

PluginOptions options [@property getter];

Client client [@property getter];

User me [@property getter];

string name();

}

Constructors

this this(PluginOptions opts = null): Constructor for initial load. Usually called from the inherited constructor.

Members

Functions

load void load(Bot bot, PluginState state = null): Used to load the Plugin, initially loading state if requred.
name string name(): Returns the name of this plugin.
unload void unload(Bot bot): Used to unload the Plugin. Saves config/storage if required.

Properties

client Client client [@property getter]: Client instance for the Bot running this plugin
config Storage config [@property getter]: Config instance for this plugin
configPath string configPath [@property getter]: Returns path to this plugins config file.
log Logger log [@property getter]: Plugin log instance.
me User me [@property getter]: User instance for the account this bot is running under
options PluginOptions options [@property getter]: PluginOptions for this plugin
storage Storage storage [@property getter]: Storage instance for this plugin.
storageDirectoryPath string storageDirectoryPath [@property getter]: Returns path to this plugins storage directory.
storagePath string storagePath [@property getter]: Returns path to this plugins storage file.

Variables

bot Bot bot;: Bot instance for this plugin. Should always be set
dynamicLibrary DynamicLibrary dynamicLibrary;: Pointer to the dynamic library, used for cleaning up on shutdown.
dynamicLibraryPath string dynamicLibraryPath;: The path to the dynamic library this plugin was loaded from. If set, this signals this Plugin was loaded from a dynamic library, and can be reloaded from the given path.
state PluginState state;: Current runtime state for this plugin