Dictionary

Category: Built-In Types

Brief Description

Dictionary type.

Methods

void clear ( )
Dictionary duplicate ( bool deep=False )
bool empty ( )
bool erase ( Variant key )
Variant get ( Variant key, Variant default=Null )
bool has ( Variant key )
bool has_all ( Array keys )
int hash ( )
Array keys ( )
int size ( )
Array values ( )

Description

Dictionary type. Associative container which contains values referenced by unique keys. Dictionaries are always passed by reference.

Erasing elements while iterating over them is not supported.

Creating a dictionary:

var d = {4: 5, "A key": "A value", 28: [1, 2, 3]}

To add a key to an existing dictionary, access it like an existing key and assign to it:

d[4] = "hello"  # Add integer 4 as a key and assign the String "hello" as its value.
d["Godot"] = 3.01  # Add String "Godot" as a key and assign the value 3.01 to it.

Method Descriptions

  • void clear ( )

Clear the dictionary, removing all key/value pairs.

Creates a copy of the dictionary, and returns it.

Returns true if the dictionary is empty.

Erase a dictionary key/value pair by key. Returns true if the given key was present in the dictionary, false otherwise. Does not erase elements while iterating over the dictionary.

Returns the current value for the specified key in the Dictionary. If the key does not exist, the method returns the value of the optional default argument, or null if it is omitted.

Returns true if the dictionary has a given key.

Returns true if the dictionary has all of the keys in the given array.

Returns a hashed integer value representing the dictionary contents. This can be used to compare dictionaries by value:

var dict1 = {0: 10}
var dict2 = {0: 10}
# The line below prints `true`, whereas it would have printed `false` if both variables were compared directly.
print(dict1.hash() == dict2.hash())

Returns the list of keys in the Dictionary.

Returns the size of the dictionary (in pairs).

Returns the list of values in the Dictionary.