summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2020-01-18 13:53:16 +0100
committerHugo Locurcio <hugo.locurcio@hugo.pro>2020-01-18 13:58:36 +0100
commit9914b6fc62555424c81918cc72b53291b43a6841 (patch)
tree7de7560c769eba095423fdaee794d0b3843b1152 /doc
parentbc4ce44d771b99f1ac8d49901630bf3d3c343c8a (diff)
doc: Mention the limited comment support in ConfigFile
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/ConfigFile.xml1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml
index d99f90d09a..68966b6f59 100644
--- a/doc/classes/ConfigFile.xml
+++ b/doc/classes/ConfigFile.xml
@@ -26,6 +26,7 @@
config.save("user://settings.cfg")
[/codeblock]
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.
</description>
<tutorials>
</tutorials>