An abstract class for plugins with all the main features already implemented. More...

Inheritance diagram for Hermod.PluginFramework.Plugin:

Public Member Functions

Plugin (string pluginName, Version pluginVersion, params ICommand[] commands)

Specialised constructor; allows inheriting classes to set their values immediately.

abstract void OnLoad (IPluginDelegator pluginDelegator)

Method that is called once the plugin has been loaded. This may be used for pre-init purposes.

Parameters

pluginDelegator The delegator allocated to this plugin.

abstract void OnStart ()

Method that is called once Hermod has completed its startup procedures and is ready to run.

abstract void OnStop ()

Method that is called when Hermod is shutting down.

abstract void OnConfigChanged (ConfigChangedEventArgs e)

Method that is called when an application-wide configuration has been modified.

Parameters

e	The ConfigChangedEventArgs that are generated when a config was modified.

abstract void OnConfigLoaded ()

Method that is called when the application-wide configurations have been loaded.

void OnLoad (IPluginDelegator pluginDelegator)

Method that is called once the plugin has been loaded. This may be used for pre-init purposes.

void OnStart ()

Method that is called once Hermod has completed its startup procedures and is ready to run.

void OnStop ()

Method that is called when Hermod is shutting down.

void OnConfigChanged (ConfigChangedEventArgs e)

Method that is called when an application-wide configuration has been modified.

void OnConfigLoaded ()

Method that is called when the application-wide configurations have been loaded.

Properties
Version	PluginVersion `[get, protected set]`
	Gets the version of the plugin.

string	PluginName `[get, protected set]`
	Gets the name of the plugin.

List< ICommand >	PluginCommands `[get, protected set]`
	A list of all commands this plugin provides.

Properties inherited from Hermod.PluginFramework.IPlugin
Version	PluginVersion `[get]`
	Gets the version of the plugin.

string	PluginName `[get]`
	Gets the name of the plugin.

List< ICommand >	PluginCommands `[get]`
	A list of all commands this plugin provides.

Detailed Description

An abstract class for plugins with all the main features already implemented.

Definition at line 13 of file Plugin.cs.

Constructor & Destructor Documentation

◆ Plugin()

Hermod.PluginFramework.Plugin.Plugin	(	string	pluginName,
		Version	pluginVersion,
		params ICommand[]	commands
	)

inline

Specialised constructor; allows inheriting classes to set their values immediately.

Parameters

pluginName	The name of the plugin.
pluginVersion	The plugin's version.
commands	A list of commands (if any).

Definition at line 21 of file Plugin.cs.

                                                                                            {
            PluginVersion = pluginVersion;
            PluginName = pluginName;
            PluginCommands = commands.ToList();
        }