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