class_dictionary.rst 4.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_Dictionary:
  4. Dictionary
  5. ==========
  6. **Category:** Built-In Types
  7. Brief Description
  8. -----------------
  9. Dictionary type.
  10. Member Functions
  11. ----------------
  12. +------------------------------+-----------------------------------------------------------------------------------------------+
  13. | void | :ref:`clear<class_Dictionary_clear>` **(** **)** |
  14. +------------------------------+-----------------------------------------------------------------------------------------------+
  15. | :ref:`bool<class_bool>` | :ref:`empty<class_Dictionary_empty>` **(** **)** |
  16. +------------------------------+-----------------------------------------------------------------------------------------------+
  17. | void | :ref:`erase<class_Dictionary_erase>` **(** var value **)** |
  18. +------------------------------+-----------------------------------------------------------------------------------------------+
  19. | :ref:`bool<class_bool>` | :ref:`has<class_Dictionary_has>` **(** var value **)** |
  20. +------------------------------+-----------------------------------------------------------------------------------------------+
  21. | :ref:`int<class_int>` | :ref:`hash<class_Dictionary_hash>` **(** **)** |
  22. +------------------------------+-----------------------------------------------------------------------------------------------+
  23. | :ref:`Array<class_array>` | :ref:`keys<class_Dictionary_keys>` **(** **)** |
  24. +------------------------------+-----------------------------------------------------------------------------------------------+
  25. | :ref:`int<class_int>` | :ref:`parse_json<class_Dictionary_parse_json>` **(** :ref:`String<class_string>` json **)** |
  26. +------------------------------+-----------------------------------------------------------------------------------------------+
  27. | :ref:`int<class_int>` | :ref:`size<class_Dictionary_size>` **(** **)** |
  28. +------------------------------+-----------------------------------------------------------------------------------------------+
  29. | :ref:`String<class_string>` | :ref:`to_json<class_Dictionary_to_json>` **(** **)** |
  30. +------------------------------+-----------------------------------------------------------------------------------------------+
  31. Description
  32. -----------
  33. Dictionary type. Associative container which contains values referenced by unique keys. Dictionaries are always passed by reference.
  34. Member Function Description
  35. ---------------------------
  36. .. _class_Dictionary_clear:
  37. - void **clear** **(** **)**
  38. Clear the dictionary, removing all key/value pairs.
  39. .. _class_Dictionary_empty:
  40. - :ref:`bool<class_bool>` **empty** **(** **)**
  41. Return true if the dictionary is empty.
  42. .. _class_Dictionary_erase:
  43. - void **erase** **(** var value **)**
  44. Erase a dictionary key/value pair by key.
  45. .. _class_Dictionary_has:
  46. - :ref:`bool<class_bool>` **has** **(** var value **)**
  47. Return true if the dictionary has a given key.
  48. .. _class_Dictionary_hash:
  49. - :ref:`int<class_int>` **hash** **(** **)**
  50. Return a hashed integer value representing the dictionary contents.
  51. .. _class_Dictionary_keys:
  52. - :ref:`Array<class_array>` **keys** **(** **)**
  53. Return the list of keys in the dictionary.
  54. .. _class_Dictionary_parse_json:
  55. - :ref:`int<class_int>` **parse_json** **(** :ref:`String<class_string>` json **)**
  56. .. _class_Dictionary_size:
  57. - :ref:`int<class_int>` **size** **(** **)**
  58. Return the size of the dictionary (in pairs).
  59. .. _class_Dictionary_to_json:
  60. - :ref:`String<class_string>` **to_json** **(** **)**