Class PluginConfig

Namespace

RisingV.Shared.Plugins

Assembly

RisingV.Shared.dll

Represents a plugin configuration class.

public class PluginConfig : BaseConfig, IPluginConfig, IConfig, IManageableLifecycle<PluginConfigManager>, IManageableLifecycle, IReloadable, IManageable<PluginConfigManager>, IManageable

Inheritance

object

BaseConfig

PluginConfig

Implements

IPluginConfig

IConfig

IManageableLifecycle<PluginConfigManager>

IManageableLifecycle

IReloadable

IManageable<PluginConfigManager>

IManageable

Derived

SharedPluginConfig

Inherited Members

BaseConfig.ConfigRelativePath

BaseConfig.ConfigFileName

BaseConfig.ConfigFile

BaseConfig.ConfigsToLoad

BaseConfig.Enabled

BaseConfig.Start()

BaseConfig.Initialize()

BaseConfig.Load()

BaseConfig.Ready()

BaseConfig.Unload()

BaseConfig.Terminate()

BaseConfig.Reload(ReloadReason)

BaseConfig.Bind<T>(string, string, T, string)

BaseConfig.GetValue<T>(string, string, T)

BaseConfig.GetEntry<T>(string, string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

EntityExtensions.IsAspect<TAspect>(object)

Constructors

PluginConfig(string?, string?)

Represents a plugin configuration class.

public PluginConfig(string? configFileName, string? configRelativePath = null)

Parameters

configFileName string

configRelativePath string

Properties

AutoLoadEngines

Try to autoload engines for the plugin via the engine's bootloader.

public ConfigEntry<bool>? AutoLoadEngines { get; }

Property Value

ConfigEntry<bool>

DependencyAutoLoad

Gets or sets a configuration entry for allowing automatic dependency loading.

public ConfigEntry<bool>? DependencyAutoLoad { get; }

Property Value

ConfigEntry<bool>

HotReload

Gets or sets a configuration entry for enabling hot reloading of the plugin.

public ConfigEntry<bool>? HotReload { get; }

Property Value

ConfigEntry<bool>

Log

protected override Logger Log { get; }

Property Value

Logger

Methods

Initialize(PluginConfigManager, List<IPlugin>)

Initializes the lifecycle of the manager with a specific type.

public void Initialize(PluginConfigManager manager, List<IPlugin> plugins)

Parameters

manager PluginConfigManager

plugins List<IPlugin>

Load(PluginConfigManager, List<IPlugin>)

Loads the manager and its dependencies with a specific type.

public void Load(PluginConfigManager manager, List<IPlugin> plugins)

Parameters

manager PluginConfigManager

plugins List<IPlugin>

Ready(PluginConfigManager, List<IPlugin>)

Prepares the manager for use with a specific type, typically after loading.

public void Ready(PluginConfigManager manager, List<IPlugin> plugins)

Parameters

manager PluginConfigManager

plugins List<IPlugin>

Reload(PluginConfigManager, List<IPlugin>, ReloadReason)

Reloads the manager and its dependencies with a specific type.

public void Reload(PluginConfigManager manager, List<IPlugin> plugins, ReloadReason reason)

Parameters

manager PluginConfigManager

plugins List<IPlugin>

reason ReloadReason

Terminate(PluginConfigManager, List<IPlugin>)

Terminates the manager and cleans up resources with a specific type.

public void Terminate(PluginConfigManager manager, List<IPlugin> plugins)

Parameters

manager PluginConfigManager

plugins List<IPlugin>

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Unload(PluginConfigManager, List<IPlugin>)

Unloads the manager and its dependencies with a specific type.

public void Unload(PluginConfigManager manager, List<IPlugin> plugins)

Parameters

manager PluginConfigManager

plugins List<IPlugin>