Class SingletonConfigSection<TConfigSection>

Namespace

MonkeyLoader.Configuration

Assembly

MonkeyLoader.dll

Represents a section of a Config for any IConfigOwner, of which there can only ever be once instance.
This is primarily useful for public config sections which others mods should be able to access.

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

Type Parameters

TConfigSection

The type of the actual config section.

Inheritance

object

ConfigSection

SingletonConfigSection<TConfigSection>

Implements

INestedIdentifiable<Config>

INestedIdentifiable

IIdentifiableOwner<ConfigSection, IDefiningConfigKey>

IIdentifiableOwner<IDefiningConfigKey>

IIdentifiable

IPrioritizable

Inherited Members

ConfigSection.keys

ConfigSection.Config

ConfigSection.Description

ConfigSection.FullId

ConfigSection.HasChanges

ConfigSection.Id

ConfigSection.InternalAccessOnly

ConfigSection.Keys

ConfigSection.Name

ConfigSection.Priority

ConfigSection.Saveable

ConfigSection.Version

ConfigSection.IncompatibilityHandling

ConfigSection.Equals(object)

ConfigSection.GetDefinedKey(IConfigKey)

ConfigSection.GetDefinedKey<T>(IDefiningConfigKey<T>)

ConfigSection.GetHashCode()

ConfigSection.OnItemChanged(IConfigKeyChangedEventArgs)

ConfigSection.Reset()

ConfigSection.TryGetDefinedKey<T>(ITypedConfigKey<T>, out IDefiningConfigKey<T>)

ConfigSection.TryGetDefinedKey(IConfigKey, out IDefiningConfigKey)

ConfigSection.DeserializeKey(IDefiningConfigKey, JObject, JsonSerializer)

ConfigSection.GetAutoConfigKeys()

ConfigSection.GetConfigKeys()

ConfigSection.OnLoad(JObject, JsonSerializer)

ConfigSection.OnSave(JObject, JsonSerializer)

ConfigSection.SerializeKey(IDefiningConfigKey, JObject, JsonSerializer)

ConfigSection.ThrowKeyNotFound(IConfigKey)

ConfigSection.ItemChanged

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

SingletonConfigSection()

Creates an instance of this config section once.

public SingletonConfigSection()

Exceptions

InvalidOperationException

When TConfigSection isn't the concrete type, or there is already an Instance of this config section.

Properties

Instance

Gets this singleton ConfigSection's instance.

public static TConfigSection Instance { get; }

Property Value

TConfigSection