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

Merge pull request #32356 from m-r-hunt/master

Browse source 
Improve documentation of ProjectSettings class
This commit is contained in:
Rémi Verschelde 2019-09-27 16:21:48 +02:00 committed by GitHub
commit ba8b2a1af7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/classes/ProjectSettings.xml
View file

@ -5,6 +5,7 @@
</brief_description> </brief_description>
<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. 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> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
@ -55,6 +56,11 @@
<argument index="0" name="name" type="String"> <argument index="0" name="name" type="String">
</argument> </argument>
<description> <description>
Returns the value of a setting.
[b]Example:[/b]
[codeblock]
print(ProjectSettings.get_setting("application/config/name"))
[/codeblock]
</description> </description>
</method> </method>
<method name="globalize_path" qualifiers="const"> <method name="globalize_path" qualifiers="const">