summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2021-09-11 16:04:35 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2021-09-11 16:08:11 +0200
commit9c6ae95cb2a44dcc3235b896252c7dadabfe533d (patch)
tree0e8a7cfd98a3c094e3688ca62ac5eb85df182c9c
parent60ed3fbf658e6338be6505410a7fed289dec500b (diff)
Document that ConfigFiles can use any file extension
The file extension given to a ConfigFile has no impact on its formatting or behavior.
-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 d6da4bc248..249e2a8f80 100644
--- a/doc/classes/ConfigFile.xml
+++ b/doc/classes/ConfigFile.xml
@@ -86,6 +86,7 @@
[/codeblocks]
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.
</description>
<tutorials>
</tutorials>