Class BaseConfig

Namespace

RisingV.Shared.Config

Assembly

RisingV.Shared.dll

Base class for configuration management.

public abstract class BaseConfig : IConfig

Inheritance

object

BaseConfig

Implements

IConfig

Derived

FeatureConfig

PluginConfig

SystemConfig

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

EntityExtensions.IsAspect<TAspect>(object)

Constructors

BaseConfig(string?, string?)

protected BaseConfig(string? configFileName = null, string? configRelativePath = null)

Parameters

configFileName string

configRelativePath string

Properties

ConfigFile

public ConfigFile? ConfigFile { get; }

Property Value

ConfigFile

ConfigFileName

public string? ConfigFileName { get; }

Property Value

string

ConfigRelativePath

public string? ConfigRelativePath { get; }

Property Value

string

ConfigsToLoad

protected List<ConfigEntryInfo> ConfigsToLoad { get; }

Property Value

List<ConfigEntryInfo>

Enabled

public ConfigEntry<bool>? Enabled { get; }

Property Value

ConfigEntry<bool>

Log

protected abstract Logger Log { get; }

Property Value

Logger

Methods

Bind<T>(string, string, T, string?)

protected virtual ConfigEntry<T>? Bind<T>(string section, string key, T defaultValue, string? description = null)

Parameters

section string

key string

defaultValue T

description string

Returns

ConfigEntry<T>

Type Parameters

T

GetEntry<T>(string, string)

protected virtual ConfigEntry<T>? GetEntry<T>(string section, string key)

Parameters

section string

key string

Returns

ConfigEntry<T>

Type Parameters

T

GetValue<T>(string, string, T?)

protected virtual T? GetValue<T>(string section, string key, T? defaultValue = default)

Parameters

section string

key string

defaultValue T

Returns

T

Type Parameters

T

Initialize()

public virtual void Initialize()

Load()

public virtual void Load()

Ready()

public virtual void Ready()

Reload(ReloadReason)

public virtual void Reload(ReloadReason reason)

Parameters

reason ReloadReason

Start()

public virtual void Start()

Terminate()

public virtual void Terminate()

Unload()

public void Unload()