Interface ISavedStateDictionary<TKey, TValue>

Namespace

SkyrimForge

Assembly

SkyrimForge.dll

A dictionary in a saved-state store whose values are stored as text.

public interface ISavedStateDictionary<TKey, TValue> : IReadOnlyDictionary<TKey, TValue>, IReadOnlyCollection<KeyValuePair<TKey, TValue>>, IEnumerable<KeyValuePair<TKey, TValue>>, IEnumerable where TKey : struct, IConvertible where TValue : struct, IParsable<TValue>

Type Parameters

TKey

TValue

Inherited Members

IReadOnlyDictionary<TKey, TValue>.ContainsKey(TKey)

IReadOnlyDictionary<TKey, TValue>.TryGetValue(TKey, out TValue)

IReadOnlyDictionary<TKey, TValue>.this[TKey]

IReadOnlyDictionary<TKey, TValue>.Keys

IReadOnlyDictionary<TKey, TValue>.Values

IReadOnlyCollection<KeyValuePair<TKey, TValue>>.Count

IEnumerable<KeyValuePair<TKey, TValue>>.GetEnumerator()

IEnumerable.GetEnumerator()

Extension Methods

EnumerableExtensions.FirstOrNull<T>(IEnumerable<T>)

EnumerableExtensions.FirstOrNull<T>(IEnumerable<T>, Func<T, bool>)

EnumerableExtensions.WhereNotNull<T>(IEnumerable<T?>)

Remarks

Keys are integers or enums, stored as their integer, so renaming an enumerator does not affect stored values. Reading an entry whose text does not parse as TValue throws FormatException.

Properties

this[TKey]

Gets or sets the value for key.

TValue this[TKey key] { get; set; }

Parameters

key TKey

Property Value

TValue

Exceptions

KeyNotFoundException

The getter is called for a key that has no value.

Methods

Remove(TKey)

Removes the value for key.

bool Remove(TKey key)

Parameters

key TKey

Returns

bool

Whether a value was removed.