diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2019-09-27 16:21:48 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-09-27 16:21:48 +0200 |
| commit | ba8b2a1af755a3e59e0275536e5e8f3728ba4235 (patch) | |
| tree | dce40bbaa5f41712e850aa0e2f165488ab1856b0 | |
| parent | 5cb926a0011cad1d0365cf7169242d79420e935a (diff) | |
| parent | 2a642e1e6df8d7a06d0495b96baa81751338f0f6 (diff) | |
Merge pull request #32356 from m-r-hunt/master
Improve documentation of ProjectSettings class
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index abf7c4d4e0..7d009252c0 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -5,6 +5,7 @@ </brief_description> <description> 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. </description> <tutorials> </tutorials> @@ -55,6 +56,11 @@ <argument index="0" name="name" type="String"> </argument> <description> + Returns the value of a setting. + [b]Example:[/b] + [codeblock] + print(ProjectSettings.get_setting("application/config/name")) + [/codeblock] </description> </method> <method name="globalize_path" qualifiers="const"> |