Reckfell.Collections.Dictionary

public Dictionary();

Returns the same dictionary as from. If you need a copy of the dictionary, use Reckfell.Collections.Dictionary.Duplicate.

public int Count { get; }

Returns the number of elements in this Reckfell.Collections.Dictionary. This is also known as the size or length of the dictionary.

public bool IsReadOnly { get; }

Returns true if the dictionary is read-only. See Reckfell.Collections.Dictionary.MakeReadOnly. Dictionaries are automatically read-only if declared with const keyword.

public Variant this[Variant key] { get; set; }

Reads an existing key value or sets a key value. Reading a missing key throws KeyNotFoundException; use TryGetValue to test presence. A present Nil value differs from absence.

public System.Collections.Generic.ICollection<Variant> Keys { get; }

Returns the list of keys in the dictionary.

public System.Collections.Generic.ICollection<Variant> Values { get; }

Returns the list of values in this dictionary.

public void Add(Variant key, Variant value);

Adds an value value at key key to this Reckfell.Collections.Dictionary.

public void Clear();

Clears the dictionary, removing all entries from it.

public bool ContainsKey(Variant key);

Checks if this Reckfell.Collections.Dictionary contains the given key.

public void Dispose();

Disposes of this Reckfell.Collections.Dictionary.

public Reckfell.Collections.Dictionary Duplicate(bool deep = false);

Returns a new copy of the dictionary. By default, a shallow copy is returned: all nested Reckfell.Collections.Array, Reckfell.Collections.Dictionary, and Resource keys and values are shared with the original dictionary. Modifying any of those in one dictionary will also affect them in the other. If deep is true, a deep copy is returned: all nested arrays and dictionaries are also duplicated (recursively). Any Resource is still shared with the original dictionary, though.

public System.Collections.Generic.IEnumerator<System.Collections.Generic.KeyValuePair<Variant, Variant>> GetEnumerator();

Gets an enumerator for this Reckfell.Collections.Dictionary.

public void MakeReadOnly();

Makes the dictionary read-only, i.e. disables modification of the dictionary's contents. Does not apply to nested content, e.g. content of nested dictionaries.

public void Merge(Reckfell.Collections.Dictionary dictionary, bool overwrite = false);

Adds entries from dictionary to this dictionary. By default, duplicate keys are not copied over, unless overwrite is true.

var dict = new Reckfell.Collections.Dictionary
{
    ["item"] = "sword",
    ["quantity"] = 2,
};

var otherDict = new Reckfell.Collections.Dictionary
{
    ["quantity"] = 15,
    ["color"] = "silver",
};

// Overwriting of existing keys is disabled by default.
dict.Merge(otherDict);
ReckfellApi.Print(dict); // { "item": "sword", "quantity": 2, "color": "silver" }

// With overwriting of existing keys enabled.
dict.Merge(otherDict, true);
ReckfellApi.Print(dict); // { "item": "sword", "quantity": 15, "color": "silver" }

Note: Reckfell.Collections.Dictionary.Merge is not recursive. Nested dictionaries are considered as keys that can be overwritten or not depending on the value of overwrite, but they will never be merged together.

public bool RecursiveEqual(Reckfell.Collections.Dictionary other);

Returns true if the two dictionaries contain the same keys and values, inner Reckfell.Collections.Dictionary and Reckfell.Collections.Array keys and values are compared recursively.

public bool Remove(Variant key);

Removes an element from this Reckfell.Collections.Dictionary by key.

public override string ToString();

Converts this Reckfell.Collections.Dictionary to a string.

public bool TryGetValue(Variant key, out Variant value);

Tests key presence and retrieves its value without a missing-key exception. True with Nil means a present key; false means an absent key and a default output Variant.