From 9914b6fc62555424c81918cc72b53291b43a6841 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Sat, 18 Jan 2020 13:53:16 +0100 Subject: [PATCH] doc: Mention the limited comment support in ConfigFile --- doc/classes/ConfigFile.xml | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml index d99f90d09aa..68966b6f596 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.