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

Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2019-10-29 12:48:46 +01:00
parent bbc6682099
commit a72184300f
449 changed files with 14004 additions and 232 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_configfile.rst
+26
View File
@@ -91,68 +91,94 @@ Method Descriptions
Deletes the specified section along with all the key-value pairs inside.
----
.. _class_ConfigFile_method_erase_section_key:
- void **erase_section_key** **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key **)**
----
.. _class_ConfigFile_method_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_method_get_sections:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_sections** **(** **)** const
Returns an array of all defined section identifiers.
----
.. _class_ConfigFile_method_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_method_has_section:
- :ref:`bool<class_bool>` **has_section** **(** :ref:`String<class_String>` section **)** const
Returns ``true`` if the specified section exists.
----
.. _class_ConfigFile_method_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_method_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 :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>`.
----
.. _class_ConfigFile_method_load_encrypted:
- :ref:`Error<enum_@GlobalScope_Error>` **load_encrypted** **(** :ref:`String<class_String>` path, :ref:`PoolByteArray<class_PoolByteArray>` key **)**
----
.. _class_ConfigFile_method_load_encrypted_pass:
- :ref:`Error<enum_@GlobalScope_Error>` **load_encrypted_pass** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` pass **)**
----
.. _class_ConfigFile_method_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 :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>`.
----
.. _class_ConfigFile_method_save_encrypted:
- :ref:`Error<enum_@GlobalScope_Error>` **save_encrypted** **(** :ref:`String<class_String>` path, :ref:`PoolByteArray<class_PoolByteArray>` key **)**
----
.. _class_ConfigFile_method_save_encrypted_pass:
- :ref:`Error<enum_@GlobalScope_Error>` **save_encrypted_pass** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` pass **)**
----
.. _class_ConfigFile_method_set_value:
- void **set_value** **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` value **)**