diff options
| author | florian <floriankothmeier@web.de> | 2018-10-02 11:07:44 +0200 |
|---|---|---|
| committer | florian <floriankothmeier@web.de> | 2018-10-02 11:52:37 +0200 |
| commit | 73429cf9f5c6733b4dcca5aa20e1832898f128c0 (patch) | |
| tree | 91ee30ac0b690386edfa5f3bb6bad643afb9a288 | |
| parent | 648b21228e791ab0e860ac973c58c5ce6d3d0898 (diff) | |
Improve doc of ProjectSettings
Documentation added for:
* bool load_resource_pack(String)
* bool property_can_revert(String)
* Variant property_get_revert(String)
* Error save()
* Error save_custom(String)
| -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 c05d6bc849..0b7c0a63ad 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -83,6 +83,8 @@ <argument index="0" name="pack" type="String"> </argument> <description> + Loads the contents of the .pck or .zip file specified by [code]pack[/code] into the resource filesystem (res://). Returns true on success. + Note: If a file from [code]pack[/code] shares the same path as a file already in the resource filesystem, any attempts to load that file will use the file from [code]pack[/code]. </description> </method> <method name="localize_path" qualifiers="const"> @@ -100,6 +102,7 @@ <argument index="0" name="name" type="String"> </argument> <description> + Returns true if the specified property exists and its initial value differs from the current value. </description> </method> <method name="property_get_revert"> @@ -108,12 +111,14 @@ <argument index="0" name="name" type="String"> </argument> <description> + Returns the initial value of the specified property. Returns null if the property does not exist. </description> </method> <method name="save"> <return type="int" enum="Error"> </return> <description> + Saves the configuration to the project.godot file. </description> </method> <method name="save_custom"> @@ -122,6 +127,7 @@ <argument index="0" name="file" type="String"> </argument> <description> + Saves the configuration to a custom file. </description> </method> <method name="set_initial_value"> |