Interface IPlugin<TConfig>

Defines the contract for basic plugin features.

Inherited Members
System.IComparable<Exiled.API.Interfaces.IPlugin<Exiled.API.Interfaces.IConfig>>.CompareTo(Exiled.API.Interfaces.IPlugin<Exiled.API.Interfaces.IConfig>)
Namespace: Exiled.API.Interfaces
Assembly: Exiled.API.dll
Syntax
public interface IPlugin<out TConfig> : IComparable<IPlugin<IConfig>> where TConfig : IConfig
Type Parameters
Name Description
TConfig

The config type.

Properties

| Improve this Doc View Source

Assembly

Gets the plugin assembly.

Declaration
Assembly Assembly { get; }
Property Value
Type Description
System.Reflection.Assembly
| Improve this Doc View Source

Author

Gets the plugin author.

Declaration
string Author { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Commands

Gets the plugin commands.

Declaration
Dictionary<Type, Dictionary<Type, ICommand>> Commands { get; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.Type, System.Collections.Generic.Dictionary<System.Type, CommandSystem.ICommand>>
| Improve this Doc View Source

Config

Gets the plugin config.

Declaration
TConfig Config { get; }
Property Value
Type Description
TConfig
| Improve this Doc View Source

ConfigPath

Gets the plugin config path.

Declaration
string ConfigPath { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

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.

Declaration
bool IgnoreRequiredVersionCheck { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

InternalTranslation

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

Declaration
ITranslation InternalTranslation { get; }
Property Value
Type Description
ITranslation
| Improve this Doc View Source

Name

Gets the plugin name.

Declaration
string Name { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Prefix

Gets the plugin prefix.

Declaration
string Prefix { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Priority

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

Declaration
PluginPriority Priority { get; }
Property Value
Type Description
PluginPriority
| Improve this Doc View Source

RequiredExiledVersion

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

Declaration
Version RequiredExiledVersion { get; }
Property Value
Type Description
System.Version
| Improve this Doc View Source

TranslationPath

Gets the plugin translation path.

Declaration
string TranslationPath { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Version

Gets the plugin version.

Declaration
Version Version { get; }
Property Value
Type Description
System.Version

Methods

| Improve this Doc View Source

OnDisabled()

Fired after disabling the plugin.

Declaration
void OnDisabled()
| Improve this Doc View Source

OnEnabled()

Fired after enabling the plugin.

Declaration
void OnEnabled()
| Improve this Doc View Source

OnRegisteringCommands()

Fired before registering commands.

Declaration
void OnRegisteringCommands()
| Improve this Doc View Source

OnReloaded()

Fired after reloading the plugin.

Declaration
void OnReloaded()
| Improve this Doc View Source

OnUnregisteringCommands()

Fired before unregistering configs.

Declaration
void OnUnregisteringCommands()

Extension Methods