Class SerializableDictionary<TKey, TValue>

A Dictionary<TKey, TValue> that survives Unity serialization. Unity's default serializer cannot persist generic dictionaries, so this type uses the standard UnityEngine.ISerializationCallbackReceiver two-list pattern to convert between the dictionary representation used at runtime and the parallel key/value lists used during serialization. Designers can edit the contents directly via a paired UI Toolkit drawer that displays the entries as a key-value table.

Inheritance
object
SerializableDictionary<TKey, TValue>
Implements
IDictionary<TKey, TValue>
ICollection<KeyValuePair<TKey, TValue>>
IEnumerable<KeyValuePair<TKey, TValue>>
ISerializationCallbackReceiver
Inherited Members
Namespace: Scylla.Core.Structures
Assembly: ScyllaCore.dll
Syntax
[Serializable]
public class SerializableDictionary<TKey, TValue> : IDictionary<TKey, TValue>, ICollection<KeyValuePair<TKey, TValue>>, IEnumerable<KeyValuePair<TKey, TValue>>, IEnumerable, ISerializationCallbackReceiver
Type Parameters
Name Description
TKey

The serializable key type.
TValue

The serializable value type.
Remarks

The dictionary itself is not serialized; the parallel _keys and _values lists are. OnBeforeSerialize() rebuilds the lists from the live dictionary and OnAfterDeserialize() rebuilds the dictionary from the lists. Duplicate keys produced by editing in the inspector are skipped silently during deserialization and a warning is emitted, leaving the dictionary in a deterministic state.

Both TKey and TValue must be Unity serializable types. Common choices for the key type are string, int, and enums. Reference type keys are supported as long as Unity can serialize them (typically via [SerializeReference] or by being a UnityEngine.Object subclass).

Concrete subclasses are required because Unity does not serialize open generic types. To use this dictionary in an Inspector, derive a non-generic concrete class:

[Serializable] public class StringIntDict : SerializableDictionary<string, int> { }

Constructors

SerializableDictionary()

Initializes a new empty dictionary.

Declaration
public SerializableDictionary()

SerializableDictionary(IDictionary<TKey, TValue>)

Initializes a new dictionary by copying the entries from source.

Declaration
public SerializableDictionary(IDictionary<TKey, TValue> source)
Parameters
Type Name Description
IDictionary<TKey, TValue> source

The source dictionary to copy from. Must not be null.
Exceptions
Type Condition
ArgumentNullException

Thrown when source is null.

Properties

Count

The number of key-value pairs in the dictionary.

Declaration
public int Count { get; }
Property Value
Type Description
int

IsReadOnly

Always false; this collection supports modification.

Declaration
public bool IsReadOnly { get; }
Property Value
Type Description
bool

this[TKey]

Gets or sets the value associated with the specified key. Throws KeyNotFoundException when reading a missing key. Setting a missing key adds it.

Declaration
public TValue this[TKey key] { get; set; }
Parameters
Type Name Description
TKey key

The key.
Property Value
Type Description
TValue

The value associated with the key.

Keys

A live collection view of the dictionary keys.

Declaration
public ICollection<TKey> Keys { get; }
Property Value
Type Description
ICollection<TKey>

Values

A live collection view of the dictionary values.

Declaration
public ICollection<TValue> Values { get; }
Property Value
Type Description
ICollection<TValue>

Methods

Add(KeyValuePair<TKey, TValue>)

Declaration
public void Add(KeyValuePair<TKey, TValue> item)
Parameters
Type Name Description
KeyValuePair<TKey, TValue> item

Add(TKey, TValue)

Declaration
public void Add(TKey key, TValue value)
Parameters
Type Name Description
TKey key
TValue value

Clear()

Declaration
public void Clear()

Contains(KeyValuePair<TKey, TValue>)

Declaration
public bool Contains(KeyValuePair<TKey, TValue> item)
Parameters
Type Name Description
KeyValuePair<TKey, TValue> item
Returns
Type Description
bool

ContainsKey(TKey)

Declaration
public bool ContainsKey(TKey key)
Parameters
Type Name Description
TKey key
Returns
Type Description
bool

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

Declaration
public void CopyTo(KeyValuePair<TKey, TValue>[] array, int arrayIndex)
Parameters
Type Name Description
KeyValuePair<TKey, TValue>[] array
int arrayIndex

GetEnumerator()

Declaration
public IEnumerator<KeyValuePair<TKey, TValue>> GetEnumerator()
Returns
Type Description
IEnumerator<KeyValuePair<TKey, TValue>>

OnAfterDeserialize()

Rebuilds the dictionary from the parallel _keys and _values lists immediately after Unity deserializes this object. Length mismatches between the two lists are tolerated by truncating to the shorter length and emitting a warning. Duplicate keys (which can occur when designers edit the lists in the inspector) are skipped and a warning is emitted, leaving the first occurrence in place.

Declaration
public void OnAfterDeserialize()

OnBeforeSerialize()

Rebuilds the parallel _keys and _values lists from the live dictionary immediately before Unity serializes this object.

Declaration
public void OnBeforeSerialize()

Remove(KeyValuePair<TKey, TValue>)

Declaration
public bool Remove(KeyValuePair<TKey, TValue> item)
Parameters
Type Name Description
KeyValuePair<TKey, TValue> item
Returns
Type Description
bool

Remove(TKey)

Declaration
public bool Remove(TKey key)
Parameters
Type Name Description
TKey key
Returns
Type Description
bool

TryGetValue(TKey, out TValue)

Declaration
public bool TryGetValue(TKey key, out TValue value)
Parameters
Type Name Description
TKey key
TValue value
Returns
Type Description
bool

Implements

UnityEngine.ISerializationCallbackReceiver

Extension Methods