Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: def522830a
Branches Tags
godot-docs
/
classes
/
class_configfile.rst

class_configfile.rst 12 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the ConfigFile.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_ConfigFile:
    8. 

  8. 

  9. ConfigFile
    10. 

  10. ==========
    11. 

  11. 

  12. **Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. **Category:** Core
    15. 

  15. 

  16. Brief Description
    17. 

  17. -----------------
    18. 

  18. 

  19. Helper class to handle INI-style files.
    20. 

  20. 

  21. Methods
    22. 

  22. -------
    23. 

  23. 

  24. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    25. 

  25. | void                                          | :ref:`erase_section<class_ConfigFile_method_erase_section>` **(** :ref:`String<class_String>` section **)**                                                                            |
    26. 

  26. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_section_keys<class_ConfigFile_method_get_section_keys>` **(** :ref:`String<class_String>` section **)** const                                                                |
    28. 

  28. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_sections<class_ConfigFile_method_get_sections>` **(** **)** const                                                                                                            |
    30. 

  30. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | :ref:`Variant<class_Variant>`                 | :ref:`get_value<class_ConfigFile_method_get_value>` **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` default=null **)** const |
    32. 

  32. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. | :ref:`bool<class_bool>`                       | :ref:`has_section<class_ConfigFile_method_has_section>` **(** :ref:`String<class_String>` section **)** const                                                                          |
    34. 

  34. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35. | :ref:`bool<class_bool>`                       | :ref:`has_section_key<class_ConfigFile_method_has_section_key>` **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key **)** const                                 |
    36. 

  36. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37. | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`load<class_ConfigFile_method_load>` **(** :ref:`String<class_String>` path **)**                                                                                                 |
    38. 

  38. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39. | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`load_encrypted<class_ConfigFile_method_load_encrypted>` **(** :ref:`String<class_String>` path, :ref:`PoolByteArray<class_PoolByteArray>` key **)**                              |
    40. 

  40. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41. | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`load_encrypted_pass<class_ConfigFile_method_load_encrypted_pass>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` pass **)**                                 |
    42. 

  42. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43. | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`save<class_ConfigFile_method_save>` **(** :ref:`String<class_String>` path **)**                                                                                                 |
    44. 

  44. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45. | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`save_encrypted<class_ConfigFile_method_save_encrypted>` **(** :ref:`String<class_String>` path, :ref:`PoolByteArray<class_PoolByteArray>` key **)**                              |
    46. 

  46. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

  47. | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`save_encrypted_pass<class_ConfigFile_method_save_encrypted_pass>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` pass **)**                                 |
    48. 

  48. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49. | void                                          | :ref:`set_value<class_ConfigFile_method_set_value>` **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` value **)**              |
    50. 

  50. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51. 

  52. Description
    53. 

  53. -----------
    54. 

  54. 

  55. This helper class can be used to store :ref:`Variant<class_Variant>` values on the filesystem using INI-style formatting. The stored values are identified by a section and a key:
    56. 

  56. 

  57. ::
    58. 

  58. 

  59.     [section]
    60. 

  60.     some_key=42
    61. 

  61.     string_example="Hello World!"
    62. 

  62.     a_vector=Vector3( 1, 0, 2 )
    63. 

  63. 

  64. The stored data can be saved to or parsed from a file, though ConfigFile objects can also be used directly without accessing the filesystem.
    65. 

  65. 

  66. The following example shows how to parse an INI-style file from the system, read its contents and store new values in it:
    67. 

  67. 

  68. ::
    69. 

  69. 

  70.     var config = ConfigFile.new()
    71. 

  71.     var err = config.load("user://settings.cfg")
    72. 

  72.     if err == OK: # If not, something went wrong with the file loading
    73. 

  73.         # Look for the display/width pair, and default to 1024 if missing
    74. 

  74.         var screen_width = config.get_value("display", "width", 1024)
    75. 

  75.         # Store a variable if and only if it hasn't been defined yet
    76. 

  76.         if not config.has_section_key("audio", "mute"):
    77. 

  77.             config.set_value("audio", "mute", false)
    78. 

  78.         # Save the changes by overwriting the previous file
    79. 

  79.         config.save("user://settings.cfg")
    80. 

  80. 

  81. Keep in mind that section and property names can't contain spaces. Anything after a space will be ignored on save and on load.
    82. 

  82. 

  83. Method Descriptions
    84. 

  84. -------------------
    85. 

  85. 

  86. .. _class_ConfigFile_method_erase_section:
    87. 

  87. 

  88. - void **erase_section** **(** :ref:`String<class_String>` section **)**
    89. 

  89. 

  90. Deletes the specified section along with all the key-value pairs inside.
    91. 

  91. 

  92. .. _class_ConfigFile_method_get_section_keys:
    93. 

  93. 

  94. - :ref:`PoolStringArray<class_PoolStringArray>` **get_section_keys** **(** :ref:`String<class_String>` section **)** const
    95. 

  95. 

  96. Returns an array of all defined key identifiers in the specified section.
    97. 

  97. 

  98. .. _class_ConfigFile_method_get_sections:
    99. 

  99. 

  100. - :ref:`PoolStringArray<class_PoolStringArray>` **get_sections** **(** **)** const
    101. 

  101. 

  102. Returns an array of all defined section identifiers.
    103. 

  103. 

  104. .. _class_ConfigFile_method_get_value:
    105. 

  105. 

  106. - :ref:`Variant<class_Variant>` **get_value** **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` default=null **)** const
    107. 

  107. 

  108. Returns the current value for the specified section and key. If the section and/or the key do not exist, the method returns the value of the optional ``default`` argument, or ``null`` if it is omitted.
    109. 

  109. 

  110. .. _class_ConfigFile_method_has_section:
    111. 

  111. 

  112. - :ref:`bool<class_bool>` **has_section** **(** :ref:`String<class_String>` section **)** const
    113. 

  113. 

  114. Returns ``true`` if the specified section exists.
    115. 

  115. 

  116. .. _class_ConfigFile_method_has_section_key:
    117. 

  117. 

  118. - :ref:`bool<class_bool>` **has_section_key** **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key **)** const
    119. 

  119. 

  120. Returns ``true`` if the specified section-key pair exists.
    121. 

  121. 

  122. .. _class_ConfigFile_method_load:
    123. 

  123. 

  124. - :ref:`Error<enum_@GlobalScope_Error>` **load** **(** :ref:`String<class_String>` path **)**
    125. 

  125. 

  126. Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>`, :ref:`@GlobalScope.FAILED<class_@GlobalScope_constant_FAILED>` or ``ERR_*`` constants listed in :ref:`@GlobalScope<class_@GlobalScope>`. If the load was successful, the return value is :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>`.
    127. 

  127. 

  128. .. _class_ConfigFile_method_load_encrypted:
    129. 

  129. 

  130. - :ref:`Error<enum_@GlobalScope_Error>` **load_encrypted** **(** :ref:`String<class_String>` path, :ref:`PoolByteArray<class_PoolByteArray>` key **)**
    131. 

  131. 

  132. .. _class_ConfigFile_method_load_encrypted_pass:
    133. 

  133. 

  134. - :ref:`Error<enum_@GlobalScope_Error>` **load_encrypted_pass** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` pass **)**
    135. 

  135. 

  136. .. _class_ConfigFile_method_save:
    137. 

  137. 

  138. - :ref:`Error<enum_@GlobalScope_Error>` **save** **(** :ref:`String<class_String>` path **)**
    139. 

  139. 

  140. Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>`, :ref:`@GlobalScope.FAILED<class_@GlobalScope_constant_FAILED>` or ``ERR_*`` constants listed in :ref:`@GlobalScope<class_@GlobalScope>`. If the load was successful, the return value is :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>`.
    141. 

  141. 

  142. .. _class_ConfigFile_method_save_encrypted:
    143. 

  143. 

  144. - :ref:`Error<enum_@GlobalScope_Error>` **save_encrypted** **(** :ref:`String<class_String>` path, :ref:`PoolByteArray<class_PoolByteArray>` key **)**
    145. 

  145. 

  146. .. _class_ConfigFile_method_save_encrypted_pass:
    147. 

  147. 

  148. - :ref:`Error<enum_@GlobalScope_Error>` **save_encrypted_pass** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` pass **)**
    149. 

  149. 

  150. .. _class_ConfigFile_method_set_value:
    151. 

  151. 

  152. - void **set_value** **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` value **)**
    153. 

  153. 

  154. Assigns a value to the specified key of the specified section. If the section and/or the key do not exist, they are created. Passing a ``null`` value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed.
    155. 

  155.