From 2a642e1e6df8d7a06d0495b96baa81751338f0f6 Mon Sep 17 00:00:00 2001 From: Max Hunt Date: Fri, 27 Sep 2019 07:32:35 +0100 Subject: [PATCH] Improve documentation of ProjectSettings class --- doc/classes/ProjectSettings.xml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index abf7c4d4e04..7d009252c03 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -5,6 +5,7 @@ Contains global variables accessible from everywhere. Use [method get_setting], [method set_setting] or [method has_setting] to access them. Variables stored in [code]project.godot[/code] are also loaded into ProjectSettings, making this object very useful for reading custom game configuration options. + When naming a Project Settings property, use the full path to the setting including the category. For example, [code]"application/config/name"[/code] for the project name. Category and property names can be viewed in the Project Settings dialog. @@ -55,6 +56,11 @@ + Returns the value of a setting. + [b]Example:[/b] + [codeblock] + print(ProjectSettings.get_setting("application/config/name")) + [/codeblock]