| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
- .. _class_Dictionary:
- Dictionary
- ==========
- **Category:** Built-In Types
- Brief Description
- -----------------
- Dictionary type.
- Member Functions
- ----------------
- +------------------------------+-----------------------------------------------------------------------------------------------+
- | void | :ref:`clear<class_Dictionary_clear>` **(** **)** |
- +------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`empty<class_Dictionary_empty>` **(** **)** |
- +------------------------------+-----------------------------------------------------------------------------------------------+
- | void | :ref:`erase<class_Dictionary_erase>` **(** var key **)** |
- +------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`has<class_Dictionary_has>` **(** var key **)** |
- +------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`has_all<class_Dictionary_has_all>` **(** :ref:`Array<class_array>` keys **)** |
- +------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`hash<class_Dictionary_hash>` **(** **)** |
- +------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`Array<class_array>` | :ref:`keys<class_Dictionary_keys>` **(** **)** |
- +------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`parse_json<class_Dictionary_parse_json>` **(** :ref:`String<class_string>` json **)** |
- +------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`size<class_Dictionary_size>` **(** **)** |
- +------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`String<class_string>` | :ref:`to_json<class_Dictionary_to_json>` **(** **)** |
- +------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`Array<class_array>` | :ref:`values<class_Dictionary_values>` **(** **)** |
- +------------------------------+-----------------------------------------------------------------------------------------------+
- Description
- -----------
- Dictionary type. Associative container which contains values referenced by unique keys. Dictionaries are always passed by reference.
- Member Function Description
- ---------------------------
- .. _class_Dictionary_clear:
- - void **clear** **(** **)**
- Clear the dictionary, removing all key/value pairs.
- .. _class_Dictionary_empty:
- - :ref:`bool<class_bool>` **empty** **(** **)**
- Return true if the dictionary is empty.
- .. _class_Dictionary_erase:
- - void **erase** **(** var key **)**
- Erase a dictionary key/value pair by key.
- .. _class_Dictionary_has:
- - :ref:`bool<class_bool>` **has** **(** var key **)**
- Return true if the dictionary has a given key.
- .. _class_Dictionary_has_all:
- - :ref:`bool<class_bool>` **has_all** **(** :ref:`Array<class_array>` keys **)**
- Return true if the dictionary has all of the keys in the given array.
- .. _class_Dictionary_hash:
- - :ref:`int<class_int>` **hash** **(** **)**
- Return a hashed integer value representing the dictionary contents.
- .. _class_Dictionary_keys:
- - :ref:`Array<class_array>` **keys** **(** **)**
- Return the list of keys in the :ref:`Dictionary<class_dictionary>`.
- .. _class_Dictionary_parse_json:
- - :ref:`int<class_int>` **parse_json** **(** :ref:`String<class_string>` json **)**
- Parse JSON text to the dictionary. Return OK when successed or the error code when failed.
- Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert every numerical values to :ref:`float<class_float>` types.
- .. _class_Dictionary_size:
- - :ref:`int<class_int>` **size** **(** **)**
- Return the size of the dictionary (in pairs).
- .. _class_Dictionary_to_json:
- - :ref:`String<class_string>` **to_json** **(** **)**
- Return the dictionary as json text.
- .. _class_Dictionary_values:
- - :ref:`Array<class_array>` **values** **(** **)**
- Return the list of values in the :ref:`Dictionary<class_dictionary>`.
|
