godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with 2.0 branch

Browse Source
This commit is contained in:
Rémi Verschelde
2016-05-12 19:47:54 +02:00
parent 3e8cc682b6
commit 76f536dd0d
33 changed files with 879 additions and 482 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
classes/class_configfile.rst
View File

@@ -13,7 +13,7 @@ ConfigFile
Brief Description
-----------------
Helper class to handle INI-style files.
Member Functions
----------------
@@ -21,7 +21,7 @@ Member Functions
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_value<class_ConfigFile_set_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var value **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`get_value<class_ConfigFile_get_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var default=NULL **)** const |
| Variant | :ref:`get_value<class_ConfigFile_get_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var default=NULL **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_section<class_ConfigFile_has_section>` **(** :ref:`String<class_string>` section **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -36,6 +36,26 @@ Member Functions
| Error | :ref:`save<class_ConfigFile_save>` **(** :ref:`String<class_string>` path **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
This helper class can be used to store :ref:`Variant<class_variant>` values on the filesystem using an INI-style formatting. The stored values as referenced by a section and a key. The stored data can be saved to or parsed from a file, though ConfigFile objects can also be used directly with accessing the filesystem.
The following example shows how to parse a INI-style file from the system, read its contents and store new values in it:
::
var config = ConfigFile.new()
var err = config.load("user://settings.cfg")
if err == OK: # if not, something went wrong with the file loading
# Look for the display/width pair, and default to 1024 if missing
var screen_width = get_value("display", "width", 1024)
# Store a variable if and only it hasn't been defined yet
if not config.has_section_key("audio", "mute"):
config.set_value("audio", "mute", false)
# Save the changes by overwriting the previous file
config.save("user://settings.cfg")
Member Function Description
---------------------------
@@ -43,32 +63,50 @@ Member Function Description
- void **set_value** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var value **)**
Assign a value to the specified key of the 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).
.. _class_ConfigFile_get_value:
- void **get_value** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var default=NULL **)** const
- Variant **get_value** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var default=NULL **)** const
Return 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 (and thus ``NULL`` if not specified).
.. _class_ConfigFile_has_section:
- :ref:`bool<class_bool>` **has_section** **(** :ref:`String<class_string>` section **)** const
Check if the specified section exists.
.. _class_ConfigFile_has_section_key:
- :ref:`bool<class_bool>` **has_section_key** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key **)** const
Check if the specified section-key pair exists.
.. _class_ConfigFile_get_sections:
- :ref:`StringArray<class_stringarray>` **get_sections** **(** **)** const
Return an array of all defined section identifiers.
.. _class_ConfigFile_get_section_keys:
- :ref:`StringArray<class_stringarray>` **get_section_keys** **(** :ref:`String<class_string>` section **)** const
Return an array of all defined key identifiers in the specified section.
.. _class_ConfigFile_load:
- Error **load** **(** :ref:`String<class_string>` path **)**
Load the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object from which the method was called. The return value is one of the OK, FAILED or ERR\_\* constants listed in :ref:`@Global Scope<class_@global scope>` (if the load was successful, it returns OK).
.. _class_ConfigFile_save:
- Error **save** **(** :ref:`String<class_string>` path **)**
Save the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure.
The return value is one of the OK, FAILED or ERR\_\* constants listed in :ref:`@Global Scope<class_@global scope>` (if the save was successful, it returns OK).