Table of Contents

Class DefiningConfigKey<T>

Namespace
MonkeyLoader.Configuration
Assembly
MonkeyLoader.dll

Represents the typed definition for a config item.

public sealed class DefiningConfigKey<T> : Entity<DefiningConfigKey<T>>, IEntity<DefiningConfigKey<T>>, IEnumerable<IComponent<DefiningConfigKey<T>>>, IDefiningConfigKey<T>, IDefiningConfigKey, IEntity<IDefiningConfigKey>, IEnumerable<IComponent<IDefiningConfigKey>>, INestedIdentifiable<ConfigSection>, INestedIdentifiable, IPrioritizable, ITypedConfigKey<T>, ITypedConfigKey, IConfigKey, IEquatable<IConfigKey>, IIdentifiable, IEntity<IDefiningConfigKey<T>>, IEnumerable<IComponent<IDefiningConfigKey<T>>>, IEnumerable

Type Parameters

T

The type of the config item's value.

Inheritance
DefiningConfigKey<T>
Implements
Inherited Members
Extension Methods

Remarks

Add extra components like this:

DefiningConfigKey<int> testKey = new("Test", ...)
{
    new ConfigKeyRange<int>(0, 255)
};

Constructors

DefiningConfigKey(string, string?, Func<T>?, bool, Predicate<T?>?)

Creates a new instance of the DefiningConfigKey<T> class with the given parameters.

public DefiningConfigKey(string id, string? description = null, Func<T>? computeDefault = null, bool internalAccessOnly = false, Predicate<T?>? valueValidator = null)

Parameters

id string

The mod-unique identifier of this config item. Must not be null or whitespace.

description string

The human-readable description of this config item.

computeDefault Func<T>

The function that computes a default value for this key. Otherwise default(T) will be used.

internalAccessOnly bool

If true, only the owning mod should have access to this config item.

valueValidator Predicate<T>

The function that checks if the given value is valid for this config item. Otherwise everything will be accepted.

Remarks

The Changed event will be fired whenever the equality comparison of the value of this key changes.
If the value type implements INotifyPropertyChanged or INotifyCollectionChanged, those events will be passed through as well.

Add extra components like this: 

DefiningConfigKey<int> testKey = new("Test", ...)
{
    new ConfigKeyRange<int>(0, 255)
};

Exceptions

ArgumentNullException

If the id is null or whitespace.

Properties

AsUntyped

Gets the untyped version of this config item.

public IConfigKey AsUntyped { get; }

Property Value

IConfigKey

Config

Gets the config this item belongs to.

public Config Config { get; }

Property Value

Config

Description

Gets the human-readable description of this config item.

public string? Description { get; }

Property Value

string

FullId

Gets the fully unique identifier for this config item.

public string FullId { get; }

Property Value

string

Remarks

Format: $"{Section.FullId}.{Id}"

HasChanges

Gets or sets whether this config item has unsaved changes.

public bool HasChanges { get; set; }

Property Value

bool

HasDescription

Gets whether this config item has a human-readable description.

public bool HasDescription { get; }

Property Value

bool

true if Description is not null; otherwise, false.

HasValue

Gets whether this config item has a set value.

public bool HasValue { get; }

Property Value

bool

Remarks

Should be automatomatically set to true when a different value is set.

Id

Gets the mod-unique identifier of this config item.

public string Id { get; }

Property Value

string

InternalAccessOnly

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

public bool InternalAccessOnly { get; }

Property Value

bool

IsDefiningKey

Gets whether this instance defines the config item with this name.

public bool IsDefiningKey { get; }

Property Value

bool

Priority

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

public int Priority { get; init; }

Property Value

int

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

Remarks

Add a priority component to this config key or set a value during initialization.

Section

Gets the ConfigSection this item belongs to.

public ConfigSection Section { get; set; }

Property Value

ConfigSection

Remarks

Should only be set once when the owning ConfigSection is initializing.

ValueType

Gets the Type of this config item's value.

public Type ValueType { get; }

Property Value

Type

Methods

Equals(IConfigKey) 

public bool Equals(IConfigKey other)

Parameters

other IConfigKey

Returns

bool

Equals(object) 

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetEnumerator() 

public IEnumerator<IComponent<IDefiningConfigKey>> GetEnumerator()

Returns

IEnumerator<IComponent<IDefiningConfigKey>>

GetHashCode() 

public override int GetHashCode()

Returns

int

GetValue()

Gets this config item's set value, falling back to the computed default.

public T? GetValue()

Returns

T

The item's internal value or its type's default.

Reset()

Removes this config item's value and attempts to reset it back to its default.

public void Reset()

SetValue(T, string?)

Set the config item's internal value to the given one.

public void SetValue(T value, string? eventLabel = null)

Parameters

value T

The value to set.

eventLabel string

The custom label that may be set by whoever changed the config.

Exceptions

ArgumentException

Tthe value didn't pass validation.

TryComputeDefault(out T?)

Tries to compute the default value for this key, if a default provider was set.

public bool TryComputeDefault(out T? defaultValue)

Parameters

defaultValue T

The computed default value if the return value is true. Otherwise default.

Returns

bool

true if the default value was successfully computed.

TryGetValue(out T?)

Tries to get this config item's set value, falling back to the computed default.

public bool TryGetValue(out T? value)

Parameters

value T

The item's internal value or its type's default.

Returns

bool

true if the config item's value was set or a default could be computer, otherwise false.

TrySetValue(T, string?)

Tries to set the config item's internal value to the given one if it passes validation.

public bool TrySetValue(T value, string? eventLabel = null)

Parameters

value T

The value to set.

eventLabel string

The custom label that may be set by whoever changed the config.

Returns

bool

true if the value was successfully set, otherwise false.

Unset()

Removes this config item's value, setting it to its type's default.

public bool Unset()

Returns

bool

Whether there was a value to remove.

Validate(T)

Checks if a value is valid for this config item.

public bool Validate(T value)

Parameters

value T

The value to check.

Returns

bool

true if the value is valid.

Events

Changed

Triggered when the internal value of this config item changes.

public event ConfigKeyChangedEventHandler<T>? Changed

Event Type

ConfigKeyChangedEventHandler<T>

Operators

implicit operator T?(DefiningConfigKey<T>)

Implicitly gets the value of this config item.

public static implicit operator T?(DefiningConfigKey<T> key)

Parameters

key DefiningConfigKey<T>

The config item to get the value of.

Returns

T

The item's internal value or its type's default.

Edit this page