maxmustermann/godot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

doc: Clarify need to save ConfigFile to apply changes to file

Browse source 
See #52645 for context.
This commit is contained in:
georgespatton 2021-09-13 15:38:43 -07:00 committed by Rémi Verschelde
parent e13d8eda1b
commit fd8bdddd5d
No known key found for this signature in database
GPG key ID: C3336907360768E1
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/classes/ConfigFile.xml
View file

@ -84,6 +84,7 @@
}
[/csharp]
[/codeblocks]
Any operation that mutates the ConfigFile such as [method set_value], [method clear], or [method erase_section], only changes what is loaded in memory. If you want to write the change to a file, you have to save the changes with [method save], [method save_encrypted], or [method save_encrypted_pass].
Keep in mind that section and property names can't contain spaces. Anything after a space will be ignored on save and on load.
ConfigFiles can also contain manually written comment lines starting with a semicolon ([code];[/code]). Those lines will be ignored when parsing the file. Note that comments will be lost when saving the ConfigFile. This can still be useful for dedicated server configuration files, which are typically never overwritten without explicit user action.
[b]Note:[/b] The file extension given to a ConfigFile does not have any impact on its formatting or behavior. By convention, the [code].cfg[/code] extension is used here, but any other extension such as [code].ini[/code] is also valid. Since neither [code].cfg[/code] nor [code].ini[/code] are standardized, Godot's ConfigFile formatting may differ from files written by other programs.
@ -94,6 +95,7 @@
<method name="clear">
<return type="void" />
<description>
Removes the entire contents of the config.
</description>
</method>
<method name="erase_section">