godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Order everything alphabetically

Browse Source 
And sync with current 2.0.x sources.
This commit is contained in:
Rémi Verschelde
2016-06-25 02:10:54 +02:00
parent 66c919aa43
commit 1b5e8c18fd
294 changed files with 20019 additions and 19071 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
classes/class_configfile.rst
View File

@@ -19,7 +19,9 @@ Member Functions
----------------
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_value<class_ConfigFile_set_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var value **)** |
| :ref:`StringArray<class_stringarray>` | :ref:`get_section_keys<class_ConfigFile_get_section_keys>` **(** :ref:`String<class_string>` section **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_sections<class_ConfigFile_get_sections>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Variant | :ref:`get_value<class_ConfigFile_get_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var default=NULL **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -27,14 +29,12 @@ Member Functions
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_section_key<class_ConfigFile_has_section_key>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_sections<class_ConfigFile_get_sections>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_section_keys<class_ConfigFile_get_section_keys>` **(** :ref:`String<class_string>` section **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`load<class_ConfigFile_load>` **(** :ref:`String<class_string>` path **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`save<class_ConfigFile_save>` **(** :ref:`String<class_string>` path **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_value<class_ConfigFile_set_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var value **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -59,11 +59,17 @@ The following example shows how to parse a INI-style file from the system, read
Member Function Description
---------------------------
.. _class_ConfigFile_set_value:
.. _class_ConfigFile_get_section_keys:
- void **set_value** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var value **)**
- :ref:`StringArray<class_stringarray>` **get_section_keys** **(** :ref:`String<class_string>` section **)** const
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).
Return an array of all defined key identifiers in the specified section.
.. _class_ConfigFile_get_sections:
- :ref:`StringArray<class_stringarray>` **get_sections** **(** **)** const
Return an array of all defined section identifiers.
.. _class_ConfigFile_get_value:
@@ -83,18 +89,6 @@ Check if the specified section exists.
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 **)**
@@ -109,4 +103,10 @@ Save the contents of the ConfigFile object to the file specified as a parameter.
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).
.. _class_ConfigFile_set_value:
- 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).