asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: Mention the limited comment support in ConfigFile

Browse source
This commit is contained in:
Hugo Locurcio 2020-01-18 13:53:16 +01:00
parent bc4ce44d77
commit 9914b6fc62
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
1 changed files with 1 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
doc/classes/ConfigFile.xml
View file

@ -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>