Class FixedKeyDictionary<TKey, TValue>

Namespace

Gamelogic.Extensions

Assembly

Gamelogic.Extensions.dll

Represents a dictionary with a fixed set of keys.

[Version(4, 5, 0)]
[Serializable]
public class FixedKeyDictionary<TKey, TValue> : IDictionary<TKey, TValue>, ICollection<KeyValuePair<TKey, TValue>>, IReadOnlyDictionary<TKey, TValue>, IReadOnlyCollection<KeyValuePair<TKey, TValue>>, IEnumerable<KeyValuePair<TKey, TValue>>, IEnumerable

Type Parameters

TKey

TValue

Inheritance

object

FixedKeyDictionary<TKey, TValue>

Implements

IDictionary<TKey, TValue>

ICollection<KeyValuePair<TKey, TValue>>

IReadOnlyDictionary<TKey, TValue>

IReadOnlyCollection<KeyValuePair<TKey, TValue>>

IEnumerable<KeyValuePair<TKey, TValue>>

IEnumerable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

CollectionExtensions.AddRange<T>(ICollection<T>, IEnumerable<T>)

CollectionExtensions.BinarySearch<TCollection, TElement>(ICollection<TCollection>, TElement, Func<TCollection, TElement>)

CollectionExtensions.BinarySearch<TCollection, TElement>(ICollection<TCollection>, TElement, Func<TCollection, TElement>, IComparer<TElement>)

CollectionExtensions.BinarySearch<TCollection, TElement>(ICollection<TCollection>, TElement, Func<TCollection, TElement>, int, int)

CollectionExtensions.BinarySearch<TCollection, TElement>(ICollection<TCollection>, TElement, Func<TCollection, TElement>, int, int, IComparer<TElement>)

CollectionExtensions.IsEmpty<T>(ICollection<T>)

PoolExtensions.AddAllAvailableFromPool<T>(ICollection<T>, IPool<T>)

PoolExtensions.AddFromPool<T>(ICollection<T>, IPool<T>, int)

PoolExtensions.TryAddFromPool<T>(ICollection<T>, IPool<T>, int)

CollectionExtensions.Aggregate<T>(IEnumerable<T>, Func<T, T, T>, Func<T, T, T>)

CollectionExtensions.AsCountable<T>(IEnumerable<T>)

CollectionExtensions.AsList<T>(IEnumerable<T>)

CollectionExtensions.ButFirst<T>(IEnumerable<T>)

CollectionExtensions.ButLast<T>(IEnumerable<T>)

CollectionExtensions.HasSameElementsAs<T>(IEnumerable<T>, IEnumerable<T>)

CollectionExtensions.HasSingle<T>(IEnumerable<T>)

CollectionExtensions.ListToString<T>(IEnumerable<T>)

CollectionExtensions.MaxBy<TSource, TKey>(IEnumerable<TSource>, Func<TSource, TKey>)

CollectionExtensions.MaxBy<TSource, TKey>(IEnumerable<TSource>, Func<TSource, TKey>, IComparer<TKey>)

CollectionExtensions.MaxItemsBy<T, TComparable>(IEnumerable<T>, Func<T, TComparable>)

CollectionExtensions.MaxItemsBy<T, TComparable>(IEnumerable<T>, Func<T, TComparable>, Comparer<TComparable>)

CollectionExtensions.MinBy<TSource, TKey>(IEnumerable<TSource>, Func<TSource, TKey>)

CollectionExtensions.MinBy<TSource, TKey>(IEnumerable<TSource>, Func<TSource, TKey>, IComparer<TKey>)

CollectionExtensions.MinItemsBy<T, TComparable>(IEnumerable<T>, Func<T, TComparable>)

CollectionExtensions.MinItemsBy<T, TComparable>(IEnumerable<T>, Func<T, TComparable>, Comparer<TComparable>)

CollectionExtensions.RandomItem<T>(IEnumerable<T>)

CollectionExtensions.RandomItem<T>(IEnumerable<T>, IRandom)

CollectionExtensions.RotateLeft<T>(IEnumerable<T>)

CollectionExtensions.RotateRight<T>(IEnumerable<T>)

CollectionExtensions.SampleRandom<T>(IEnumerable<T>, int)

CollectionExtensions.SampleRandom<T>(IEnumerable<T>, int, IRandom)

CollectionExtensions.SlidingWindow<T>(IEnumerable<T>, int)

CollectionExtensions.TakeHalf<T>(IEnumerable<T>)

CollectionExtensions.TakeLast<T>(IEnumerable<T>, int)

CollectionExtensions.TryFirst<T>(IEnumerable<T>, out T)

CollectionExtensions.TryFirst<T>(IEnumerable<T>, Func<T, bool>, out T)

CollectionExtensions.TryLast<T>(IEnumerable<T>, out T)

CollectionExtensions.TryLast<T>(IEnumerable<T>, Func<T, bool>, out T)

CollectionExtensions.TrySingle<T>(IEnumerable<T>, out T)

CollectionExtensions.WithIndices<T>(IEnumerable<T>)

Combinatorial.Combinations<T>(IEnumerable<T>, int)

Combinatorial.Partitions<T>(IEnumerable<T>)

Combinatorial.Permutations<T>(IEnumerable<T>)

Combinatorial.PowerSet<T>(IEnumerable<T>)

Combinatorial.Tuples<T>(IEnumerable<T>)

ThrowHelper.ThrowIfNull(object, string)

Remarks

This is not meant to be used for large dictionaries, as it does not provide constant time access to elements.

A list is used to store elements so that they are more easily serialized (since Unity 2020.1).

However, it is not possible for a key to appear twice.

Furthermore, the usual way to use this is to map all IDs to GameObjects; this is done by calling Validate(IEnumerable<TKey>) with a list of all IDs in the order they should appear. This will ensure that all IDs are in the dictionary, and that Keys (and their corresponding Values) are in the correct order.

It is possible for values to be null.

Null is not allowed as a key.

We would have liked to set the keys in the constructor, but since we are building this class to work with Unity's serialization, a method that sets the keys is used instead (Validate(IEnumerable<TKey>)). This can be called from OnValidate in the component where it is being used. This means setting the keys happens at edit time, not runtime.

During development, keys may change; calling Clear() (which appears as an inspector button) will reset IDs.

Fields

keys

pairs

Properties

Count

Gets the number of key–value pairs contained in the dictionary.

IsReadOnly

Gets a value indicating whether the dictionary is read-only.

this[TKey]

Gets or sets the value associated with the specified key.

Keys

Gets a collection containing the keys of the dictionary.

Values

Gets a collection containing the values of the dictionary.

Methods

Add(KeyValuePair<TKey, TValue>)

Adds the specified key–value pair to the dictionary.

Add(TKey, TValue)

Adds a key–value pair to the dictionary.

Clear()

Removes all key–value pairs from the dictionary.

Contains(KeyValuePair<TKey, TValue>)

Determines whether the dictionary contains the specified key–value pair.

ContainsKey(TKey)

Determines whether the dictionary contains the specified key.

CopyTo(KeyValuePair<TKey, TValue>[], int)

Copies the elements of the dictionary to an array, starting at the specified index.

GetEnumerator()

Returns an enumerator that iterates through the dictionary.

Remove(KeyValuePair<TKey, TValue>)

Removes the specified key–value pair.

Remove(TKey)

Removes the entry with the specified key.

TryGetValue(TKey, out TValue)

Attempts to retrieve the value associated with the specified key.

Validate(IEnumerable<TKey>)

Validates the dictionary by ensuring that all provided keys exist and appear in the specified order. Missing keys are added with default values, and existing keys are re-ordered.