2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2019-07-05 09:32:53 +00:00
<class name= "Dictionary" category= "Built-In Types" version= "3.1.2" >
2017-09-12 20:42:36 +00:00
<brief_description >
Dictionary type.
</brief_description>
<description >
Dictionary type. Associative container which contains values referenced by unique keys. Dictionaries are always passed by reference.
2019-02-10 20:28:22 +00:00
Erasing elements while iterating over them [b]is not supported[/b].
2019-03-14 00:08:14 +00:00
Creating a dictionary:
[codeblock]
var d = {4: 5, "A key": "A value", 28: [1, 2, 3]}
[/codeblock]
To add a key to an existing dictionary, access it like an existing key and assign to it:
[codeblock]
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.
[/codeblock]
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
2019-06-01 09:39:12 +00:00
<link > https://docs.godotengine.org/en/3.1/getting_started/scripting/gdscript/gdscript_basics.html#dictionary</link>
2017-09-12 20:42:36 +00:00
</tutorials>
<methods >
<method name= "clear" >
<description >
Clear the dictionary, removing all key/value pairs.
</description>
</method>
2017-12-18 07:13:58 +00:00
<method name= "duplicate" >
<return type= "Dictionary" >
</return>
2018-04-10 08:12:42 +00:00
<argument index= "0" name= "deep" type= "bool" default= "False" >
</argument>
2017-12-18 07:13:58 +00:00
<description >
2018-04-17 14:18:57 +00:00
Creates a copy of the dictionary, and returns it.
2017-12-18 07:13:58 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "empty" >
<return type= "bool" >
</return>
<description >
2019-04-17 11:42:56 +00:00
Return [code]true[/code] if the dictionary is empty.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "erase" >
2018-08-20 22:35:30 +00:00
<return type= "bool" >
</return>
2018-08-31 20:38:28 +00:00
<argument index= "0" name= "key" type= "Variant" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2019-05-04 15:15:20 +00:00
Erase a dictionary key/value pair by key. Returns [code]true[/code] if the given key was present in the dictionary, [code]false[/code] otherwise. Do not erase elements while iterating over the dictionary.
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-11-20 08:34:45 +00:00
<method name= "get" >
<return type= "Variant" >
</return>
<argument index= "0" name= "key" type= "Variant" >
</argument>
<argument index= "1" name= "default" type= "Variant" default= "Null" >
</argument>
<description >
Returns the current value for the specified key in the [code]Dictionary[/code]. If the key does not exist, the method returns the value of the optional default argument, or Null if it is omitted.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "has" >
<return type= "bool" >
</return>
2018-08-31 20:38:28 +00:00
<argument index= "0" name= "key" type= "Variant" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2019-04-17 11:42:56 +00:00
Return [code]true[/code] if the dictionary has a given key.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "has_all" >
<return type= "bool" >
</return>
<argument index= "0" name= "keys" type= "Array" >
</argument>
<description >
2019-04-17 11:42:56 +00:00
Return [code]true[/code] if the dictionary has all of the keys in the given array.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "hash" >
<return type= "int" >
</return>
<description >
Return a hashed integer value representing the dictionary contents.
</description>
</method>
<method name= "keys" >
<return type= "Array" >
</return>
<description >
2017-10-22 10:56:11 +00:00
Return the list of keys in the [code]Dictionary[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "size" >
<return type= "int" >
</return>
<description >
Return the size of the dictionary (in pairs).
</description>
</method>
<method name= "values" >
<return type= "Array" >
</return>
<description >
2017-10-22 10:56:11 +00:00
Return the list of values in the [code]Dictionary[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<constants >
</constants>
</class>