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)
(cherry picked from commit 73429cf9f5
)
This commit is contained in:
parent
c4e827bba4
commit
0f62f281ae
|
@ -83,6 +83,8 @@
|
||||||
<argument index="0" name="pack" type="String">
|
<argument index="0" name="pack" type="String">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<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>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="localize_path" qualifiers="const">
|
<method name="localize_path" qualifiers="const">
|
||||||
|
@ -100,6 +102,7 @@
|
||||||
<argument index="0" name="name" type="String">
|
<argument index="0" name="name" type="String">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns true if the specified property exists and its initial value differs from the current value.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="property_get_revert">
|
<method name="property_get_revert">
|
||||||
|
@ -108,12 +111,14 @@
|
||||||
<argument index="0" name="name" type="String">
|
<argument index="0" name="name" type="String">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns the initial value of the specified property. Returns null if the property does not exist.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="save">
|
<method name="save">
|
||||||
<return type="int" enum="Error">
|
<return type="int" enum="Error">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<description>
|
||||||
|
Saves the configuration to the project.godot file.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="save_custom">
|
<method name="save_custom">
|
||||||
|
@ -122,6 +127,7 @@
|
||||||
<argument index="0" name="file" type="String">
|
<argument index="0" name="file" type="String">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Saves the configuration to a custom file.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="set_initial_value">
|
<method name="set_initial_value">
|
||||||
|
|
Loading…
Reference in New Issue