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: Add property overview and setter/getter like in editor docs

Browse Source 
Output from godotengine/godot#22013.
Fixes #1729.
This commit is contained in:
Rémi Verschelde
2018-09-13 11:06:52 +02:00
parent f9caa4be29
commit ab3f908221
578 changed files with 33831 additions and 6706 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
classes/class_configfile.rst
View File

@@ -8,6 +8,7 @@ ConfigFile
==========
**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
@@ -70,58 +71,57 @@ The following example shows how to parse an INI-style file from the system, read
Method Descriptions
-------------------
.. _class_ConfigFile_erase_section:
.. _class_ConfigFile_erase_section:
- void **erase_section** **(** :ref:`String<class_String>` section **)**
Deletes the specified section along with all the key-value pairs inside.
.. _class_ConfigFile_get_section_keys:
.. _class_ConfigFile_get_section_keys:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_section_keys** **(** :ref:`String<class_String>` section **)** const
Returns an array of all defined key identifiers in the specified section.
.. _class_ConfigFile_get_sections:
.. _class_ConfigFile_get_sections:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_sections** **(** **)** const
Returns an array of all defined section identifiers.
.. _class_ConfigFile_get_value:
.. _class_ConfigFile_get_value:
- :ref:`Variant<class_Variant>` **get_value** **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` default=null **)** const
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.
.. _class_ConfigFile_has_section:
.. _class_ConfigFile_has_section:
- :ref:`bool<class_bool>` **has_section** **(** :ref:`String<class_String>` section **)** const
Returns ``true`` if the specified section exists.
.. _class_ConfigFile_has_section_key:
.. _class_ConfigFile_has_section_key:
- :ref:`bool<class_bool>` **has_section_key** **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key **)** const
Returns ``true`` if the specified section-key pair exists.
.. _class_ConfigFile_load:
.. _class_ConfigFile_load:
- :ref:`Error<enum_@GlobalScope_Error>` **load** **(** :ref:`String<class_String>` path **)**
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 ``OK``, ``FAILED`` or ``ERR_*`` constants listed in :ref:`@GlobalScope<class_@GlobalScope>`. If the load was successful, the return value is ``OK``.
.. _class_ConfigFile_save:
.. _class_ConfigFile_save:
- :ref:`Error<enum_@GlobalScope_Error>` **save** **(** :ref:`String<class_String>` path **)**
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 ``OK``, ``FAILED`` or ``ERR_*`` constants listed in :ref:`@GlobalScope<class_@GlobalScope>`. If the load was successful, the return value is ``OK``.
.. _class_ConfigFile_set_value:
.. _class_ConfigFile_set_value:
- void **set_value** **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` value **)**
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.