class_configfile.rst 4.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  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_ConfigFile:
  4. ConfigFile
  5. ==========
  6. **Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Member Functions
  11. ----------------
  12. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
  13. | void | :ref:`set_value<class_ConfigFile_set_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var value **)** |
  14. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | void | :ref:`get_value<class_ConfigFile_get_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var default=NULL **)** const |
  16. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`bool<class_bool>` | :ref:`has_section<class_ConfigFile_has_section>` **(** :ref:`String<class_string>` section **)** const |
  18. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`bool<class_bool>` | :ref:`has_section_key<class_ConfigFile_has_section_key>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key **)** const |
  20. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`StringArray<class_stringarray>` | :ref:`get_sections<class_ConfigFile_get_sections>` **(** **)** const |
  22. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`StringArray<class_stringarray>` | :ref:`get_section_keys<class_ConfigFile_get_section_keys>` **(** :ref:`String<class_string>` section **)** const |
  24. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | Error | :ref:`load<class_ConfigFile_load>` **(** :ref:`String<class_string>` path **)** |
  26. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | Error | :ref:`save<class_ConfigFile_save>` **(** :ref:`String<class_string>` path **)** |
  28. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. Member Function Description
  30. ---------------------------
  31. .. _class_ConfigFile_set_value:
  32. - void **set_value** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var value **)**
  33. .. _class_ConfigFile_get_value:
  34. - void **get_value** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var default=NULL **)** const
  35. .. _class_ConfigFile_has_section:
  36. - :ref:`bool<class_bool>` **has_section** **(** :ref:`String<class_string>` section **)** const
  37. .. _class_ConfigFile_has_section_key:
  38. - :ref:`bool<class_bool>` **has_section_key** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key **)** const
  39. .. _class_ConfigFile_get_sections:
  40. - :ref:`StringArray<class_stringarray>` **get_sections** **(** **)** const
  41. .. _class_ConfigFile_get_section_keys:
  42. - :ref:`StringArray<class_stringarray>` **get_section_keys** **(** :ref:`String<class_string>` section **)** const
  43. .. _class_ConfigFile_load:
  44. - Error **load** **(** :ref:`String<class_string>` path **)**
  45. .. _class_ConfigFile_save:
  46. - Error **save** **(** :ref:`String<class_string>` path **)**