Interface IPlugin<TConfig>

Namespace

Exiled.API.Interfaces

Assembly

Exiled.API.dll

Defines the contract for basic plugin features.

public interface IPlugin<out TConfig> : IComparable<IPlugin<IConfig>> where TConfig : IConfig

Type Parameters

TConfig

The config type.

Inherited Members

IComparable<IPlugin<IConfig>>.CompareTo(IPlugin<IConfig>)

Extension Methods

ReflectionExtensions.CopyProperties(object, object)

Properties

Assembly

Gets the plugin assembly.

Assembly Assembly { get; }

Property Value

Assembly

Author

Gets the plugin author.

string Author { get; }

Property Value

string

Commands

Gets the plugin commands.

Dictionary<Type, Dictionary<Type, ICommand>> Commands { get; }

Property Value

Dictionary<Type, Dictionary<Type, ICommand>>

Config

Gets the plugin config.

TConfig Config { get; }

Property Value

TConfig

ConfigPath

Gets the plugin config path.

string ConfigPath { get; }

Property Value

string

IgnoreRequiredVersionCheck

Gets a value indicating whether a plugin should bypass the required EXILED version check. This should only be used by plugins which do not need to be updated across major version updates.

bool IgnoreRequiredVersionCheck { get; }

Property Value

bool

InternalTranslation

Gets the internally used translations. Plugins should implement Plugin<TConfig, TTranslation> and use Translation.

ITranslation InternalTranslation { get; }

Property Value

ITranslation

Name

Gets the plugin name.

string Name { get; }

Property Value

string

Prefix

Gets the plugin prefix.

string Prefix { get; }

Property Value

string

Priority

Gets the plugin priority. Higher values mean higher priority and vice versa.

PluginPriority Priority { get; }

Property Value

PluginPriority

RequiredExiledVersion

Gets the required version of Exiled to run the plugin without bugs or incompatibilities.

Version RequiredExiledVersion { get; }

Property Value

Version

TranslationPath

Gets the plugin translation path.

string TranslationPath { get; }

Property Value

string

Version

Gets the plugin version.

Version Version { get; }

Property Value

Version

Methods

OnDisabled()

Fired after disabling the plugin.

void OnDisabled()

OnEnabled()

Fired after enabling the plugin.

void OnEnabled()

OnRegisteringCommands()

Fired before registering commands.

void OnRegisteringCommands()

OnReloaded()

Fired after reloading the plugin.

void OnReloaded()

OnUnregisteringCommands()

Fired before unregistering configs.

void OnUnregisteringCommands()