stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 17:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch

Browse Source
This commit is contained in:
Rémi Verschelde
2017-04-07 22:11:07 +02:00
parent 447b439db5
commit c282b77a58
392 changed files with 14087 additions and 12472 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_configfile.rst
+25 -19
View File
@@ -18,23 +18,25 @@ Helper class to handle INI-style files.
Member Functions
----------------
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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 |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_value<class_ConfigFile_get_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, :ref:`Variant<class_variant>` default=NULL **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_section<class_ConfigFile_has_section>` **(** :ref:`String<class_string>` section **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_section_key<class_ConfigFile_has_section_key>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key **)** 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, :ref:`Variant<class_variant>` value **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_section<class_ConfigFile_erase_section>` **(** :ref:`String<class_string>` section **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_section_keys<class_ConfigFile_get_section_keys>` **(** :ref:`String<class_string>` section **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_sections<class_ConfigFile_get_sections>` **(** **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_value<class_ConfigFile_get_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, :ref:`Variant<class_variant>` default=NULL **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_section<class_ConfigFile_has_section>` **(** :ref:`String<class_string>` section **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_section_key<class_ConfigFile_has_section_key>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key **)** 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, :ref:`Variant<class_variant>` value **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -59,15 +61,19 @@ The following example shows how to parse a INI-style file from the system, read
Member Function Description
---------------------------
.. _class_ConfigFile_erase_section:
- void **erase_section** **(** :ref:`String<class_string>` section **)**
.. _class_ConfigFile_get_section_keys:
- :ref:`StringArray<class_stringarray>` **get_section_keys** **(** :ref:`String<class_string>` section **)** const
- :ref:`PoolStringArray<class_poolstringarray>` **get_section_keys** **(** :ref:`String<class_string>` section **)** const
Return an array of all defined key identifiers in the specified section.
.. _class_ConfigFile_get_sections:
- :ref:`StringArray<class_stringarray>` **get_sections** **(** **)** const
- :ref:`PoolStringArray<class_poolstringarray>` **get_sections** **(** **)** const
Return an array of all defined section identifiers.