Class PluginBootstrapper
An optional entry point for your plugin
public abstract class PluginBootstrapper
- Inheritance
-
PluginBootstrapper
Methods
AddFeaturePrerequisite<T>(PluginPrerequisite)
Adds the provided prerequisite to the feature of type T
.
public void AddFeaturePrerequisite<T>(PluginPrerequisite prerequisite) where T : PluginFeature
Parameters
prerequisite
PluginPrerequisiteThe prerequisite to add
Type Parameters
T
AddPluginPrerequisite(PluginPrerequisite)
Adds the provided prerequisite to the plugin.
public void AddPluginPrerequisite(PluginPrerequisite prerequisite)
Parameters
prerequisite
PluginPrerequisiteThe prerequisite to add
OnPluginDisabled(Plugin)
Called when the plugin is deactivated or when Artemis shuts down
public virtual void OnPluginDisabled(Plugin plugin)
Parameters
plugin
PluginThe plugin instance of your plugin
OnPluginEnabled(Plugin)
Called when the plugin is activated
public virtual void OnPluginEnabled(Plugin plugin)
Parameters
plugin
PluginThe plugin instance of your plugin
OnPluginLoaded(Plugin)
Called when the plugin is loaded
public virtual void OnPluginLoaded(Plugin plugin)
Parameters
plugin
Plugin
RemoveFeaturePrerequisite<T>(PluginPrerequisite)
Removes the provided prerequisite from the feature of type T
.
public bool RemoveFeaturePrerequisite<T>(PluginPrerequisite prerequisite) where T : PluginFeature
Parameters
prerequisite
PluginPrerequisiteThe prerequisite to remove
Returns
- bool
true is successfully removed; otherwise false. This method also returns false if the prerequisite was not found.
Type Parameters
T
RemovePluginPrerequisite(PluginPrerequisite)
Removes the provided prerequisite from the plugin.
public bool RemovePluginPrerequisite(PluginPrerequisite prerequisite)
Parameters
prerequisite
PluginPrerequisiteThe prerequisite to remove