Class ConfigSection

Namespace

MonkeyLoader.Configuration

Assembly

MonkeyLoader.dll

Represents a section of a Config for any IConfigOwner.

public abstract class ConfigSection : INestedIdentifiable<Config>, INestedIdentifiable, IIdentifiableOwner<ConfigSection, IDefiningConfigKey>, IIdentifiableOwner<IDefiningConfigKey>, IIdentifiable, IPrioritizable

Inheritance

object

ConfigSection

Implements

INestedIdentifiable<Config>

INestedIdentifiable

IIdentifiableOwner<ConfigSection, IDefiningConfigKey>

IIdentifiableOwner<IDefiningConfigKey>

IIdentifiable

IPrioritizable

Derived

ExpandoConfigSection

SingletonConfigSection<TConfigSection>

LoggingConfig

LocationConfigSection

NuGetConfigSection

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

IdentifiableExtensions.FindNearestParent<TParentIdentifiable>(IIdentifiable)

IdentifiableExtensions.FindNearestParent<TParentIdentifiable>(IIdentifiable, Predicate<TParentIdentifiable>)

IdentifiableExtensions.TryFindNearestParent<TParentIdentifiable>(IIdentifiable, Predicate<TParentIdentifiable>, out TParentIdentifiable?)

IdentifiableExtensions.TryFindNearestParent<TParentIdentifiable>(IIdentifiable, out TParentIdentifiable?)

IdentifiableExtensions.Get<TOwner, TIdentifiable>(IIdentifiableOwner<TOwner, TIdentifiable>)

IdentifiableExtensions.TryGet<TOwner, TIdentifiable>(IIdentifiableOwner<TOwner, TIdentifiable>)

IdentifiableExtensions.Get<TIdentifiable>(IIdentifiableOwner<TIdentifiable>)

IdentifiableExtensions.TryGet<TIdentifiable>(IIdentifiableOwner<TIdentifiable>)

Remarks

Use your mod's Config instance to load sections.

Constructors

ConfigSection()

Creates a new config section instance.

protected ConfigSection()

Fields

keys

Stores the IDefiningConfigKeys tracked by this section.

protected readonly HashSet<IDefiningConfigKey> keys

Field Value

HashSet<IDefiningConfigKey>

Properties

Config

Gets the Config that this section is a part of.

public Config Config { get; }

Property Value

Config

Description

Gets a description of the config items found in this section.

public abstract string Description { get; }

Property Value

string

FullId

Gets the fully qualified unique identifier for this section.

public string FullId { get; }

Property Value

string

Remarks

Format: $"{Config.Owner.Id}.{Id}"

HasChanges

Gets whether there are any config keys with unsaved changes in this section.

public bool HasChanges { get; }

Property Value

bool

Id

Gets the mod-unique identifier of this section.

public abstract string Id { get; }

Property Value

string

IncompatibilityHandling

Gets the way that an incompatible saved configuration should be treated.
Error by default

protected virtual IncompatibleConfigHandling IncompatibilityHandling { get; }

Property Value

IncompatibleConfigHandling

InternalAccessOnly

Gets whether only the owning mod should have access to this config item.

public virtual bool InternalAccessOnly { get; }

Property Value

bool

Remarks

By default: false.

Keys

Gets all the config keys of this section in order of their priority.

public IEnumerable<IDefiningConfigKey> Keys { get; }

Property Value

IEnumerable<IDefiningConfigKey>

Name

Gets the name for this section.

public virtual string Name { get; }

Property Value

string

Priority

Gets the priority of this item. Use an agreed standard as a base.

public virtual int Priority { get; }

Property Value

int

An interger used to sort the prioritizable items.
Higher comes first with the default comparer.

Remarks

Controls in which order the sections of a Config are listed.

Saveable

Gets whether this config section is allowed to be saved.
This can be false if something went wrong while loading it.

public bool Saveable { get; }

Property Value

bool

Version

Gets the semantic version for this config section.
This is used to check if the defined and saved configs are compatible.

public abstract Version Version { get; }

Property Value

Version

Methods

DeserializeKey(IDefiningConfigKey, JObject, JsonSerializer)

Deserializes the given key from the source with the jsonSerializer, if there is a value.

protected void DeserializeKey(IDefiningConfigKey key, JObject source, JsonSerializer jsonSerializer)

Parameters

key IDefiningConfigKey

The key to deserialize.

source JObject

The Newtonsoft.Json.Linq.JObject being deserialized from.

jsonSerializer JsonSerializer

The Newtonsoft.Json.JsonSerializer to deserialize objects with.

Equals(object)

Checks if the given object can be considered equal to this one.

public override bool Equals(object obj)

Parameters

obj object

The other object.

Returns

bool

true if the other object is considered equal.

GetAutoConfigKeys()

Gets the IDefiningConfigKeys from all fields of this ConfigSection which have a Type derived from IDefiningConfigKey and don't have a IgnoreConfigKeyAttribute.

protected IEnumerable<IDefiningConfigKey> GetAutoConfigKeys()

Returns

IEnumerable<IDefiningConfigKey>

The automatically tracked IDefiningConfigKeys.

GetConfigKeys()

Gets all IDefiningConfigKeys which should be tracked for this ConfigSection.

protected virtual IEnumerable<IDefiningConfigKey> GetConfigKeys()

Returns

IEnumerable<IDefiningConfigKey>

All IDefiningConfigKeys to track.

Remarks

By default: Calls GetAutoConfigKeys().

GetDefinedKey(IConfigKey)

Gets the IDefiningConfigKey defined in this config section, which matches the given templateKey.

public IDefiningConfigKey GetDefinedKey(IConfigKey templateKey)

Parameters

templateKey IConfigKey

The config item to search for.

Returns

IDefiningConfigKey

The matching item defined in this config section.

Exceptions

KeyNotFoundException

When no matching item is defined in this config section.

GetDefinedKey<T>(IDefiningConfigKey<T>)

Gets the IDefiningConfigKey<T> defined in this config section, which matches the given templateKey.

public IDefiningConfigKey<T> GetDefinedKey<T>(IDefiningConfigKey<T> templateKey)

Parameters

templateKey IDefiningConfigKey<T>

The config item to search for.

Returns

IDefiningConfigKey<T>

The matching item defined in this config section.

Type Parameters

T

Exceptions

KeyNotFoundException

When no matching item is defined in this config section.

GetHashCode()

public override int GetHashCode()

Returns

int

OnItemChanged(IConfigKeyChangedEventArgs)

Invokes this config section's ItemChanged event, and passes the invocation on to the Config and MonkeyLoader it belongs to.

public void OnItemChanged(IConfigKeyChangedEventArgs configKeyChangedEventArgs)

Parameters

configKeyChangedEventArgs IConfigKeyChangedEventArgs

The data for the event.

OnLoad(JObject, JsonSerializer)

Deserializes all keys of this ConfigSection from the source Newtonsoft.Json.Linq.JObject.

protected virtual void OnLoad(JObject source, JsonSerializer jsonSerializer)

Parameters

source JObject

The Newtonsoft.Json.Linq.JObject being deserialized from. May be empty for when file didn't have it yet.

jsonSerializer JsonSerializer

The Newtonsoft.Json.JsonSerializer to deserialize objects with.

Remarks

By default: Deserializes all keys from the source with the jsonSerializer.

Exceptions

ConfigLoadException

When the value for a key fails to deserialize.

OnSave(JObject, JsonSerializer)

Serializes all keys of this ConfigSection to the result Newtonsoft.Json.Linq.JObject.

protected virtual void OnSave(JObject result, JsonSerializer jsonSerializer)

Parameters

result JObject

The Newtonsoft.Json.Linq.JObject being serialized to.

jsonSerializer JsonSerializer

The Newtonsoft.Json.JsonSerializer to serialize objects with.

Remarks

By default: Serializes all keys to the result with the jsonSerializer.

Reset()

Removes the value of all keys of this config section and resets them to their default.

public void Reset()

SerializeKey(IDefiningConfigKey, JObject, JsonSerializer)

Serializes the given key to the result with the jsonSerializer, if the value can be gotten.

protected void SerializeKey(IDefiningConfigKey key, JObject result, JsonSerializer jsonSerializer)

Parameters

key IDefiningConfigKey

The key to serialize.

result JObject

The Newtonsoft.Json.Linq.JObject being serialized to.

jsonSerializer JsonSerializer

The Newtonsoft.Json.JsonSerializer to serialize objects with.

ThrowKeyNotFound(IConfigKey)

Throws a KeyNotFoundException for the given key in this config section.

protected void ThrowKeyNotFound(IConfigKey key)

Parameters

key IConfigKey

The key that wasn't found.

Exceptions

KeyNotFoundException

Always.

TryGetDefinedKey(IConfigKey, out IDefiningConfigKey?)

Determines if this config section contains an item matching the templateKey and returns the optional match as definingKey.

public bool TryGetDefinedKey(IConfigKey templateKey, out IDefiningConfigKey? definingKey)

Parameters

templateKey IConfigKey

The config item to search for.

definingKey IDefiningConfigKey

The optional match for the searched item. Will also contain a match not from this config section.

Returns

bool

true if this config section contains the matching item; otherwise, false.

TryGetDefinedKey<T>(ITypedConfigKey<T>, out IDefiningConfigKey<T>?)

Determines if this config section contains an item matching the typedTemplateKey and returns the optional match as definingKey.

public bool TryGetDefinedKey<T>(ITypedConfigKey<T> typedTemplateKey, out IDefiningConfigKey<T>? definingKey)

Parameters

typedTemplateKey ITypedConfigKey<T>

The config item to search for.

definingKey IDefiningConfigKey<T>

The optional match for the searched item. Will also contain a match not from this config section.

Returns

bool

true if this config section contains the matching item; otherwise, false.

Type Parameters

T

Events

ItemChanged

Called when the value of one of this config's items gets changed.

public event ConfigKeyChangedEventHandler? ItemChanged

Event Type

ConfigKeyChangedEventHandler

Operators

operator ==(ConfigSection?, ConfigSection?)

Checks if two ConfigSections are equal.

public static bool operator ==(ConfigSection? left, ConfigSection? right)

Parameters

left ConfigSection

The first section.

right ConfigSection

The second section.

Returns

bool

true if they're considered equal.

operator !=(ConfigSection?, ConfigSection?)

Checks if two ConfigSections are unequal.

public static bool operator !=(ConfigSection? left, ConfigSection? right)

Parameters

left ConfigSection

The first section.

right ConfigSection

The second section.

Returns

bool

true if they're considered unequal.