diff options
| author | Pierre-Thomas Meisels <meisels27@yahoo.fr> | 2022-02-10 20:11:40 +0100 |
|---|---|---|
| committer | Pierre-Thomas Meisels <meisels27@yahoo.fr> | 2022-03-07 10:39:51 +0100 |
| commit | f9d4f080901ffbe1b4cc92728c0bc41074068359 (patch) | |
| tree | f77601ba77eb8d7a13fffbd76c0b51e66f3ee63a /doc/classes | |
| parent | 2a39a1c2217a1d31826cd68f03cfdd8a0be769f0 (diff) | |
Fix ResourceSaver::save method exposition flag parameter
enh: Add FLAG_NONE to SaverFlags in ResourceSaver to fix api inconsistency
fix: flags parameter of ResourceSaver::save is now uint32_t to allow flag composition in scripts
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/ResourceSaver.xml | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/classes/ResourceSaver.xml b/doc/classes/ResourceSaver.xml index 39f166db2e..a7723c3f8d 100644 --- a/doc/classes/ResourceSaver.xml +++ b/doc/classes/ResourceSaver.xml @@ -21,15 +21,18 @@ <return type="int" enum="Error" /> <argument index="0" name="path" type="String" /> <argument index="1" name="resource" type="Resource" /> - <argument index="2" name="flags" type="int" enum="ResourceSaver.SaverFlags" default="0" /> + <argument index="2" name="flags" type="int" default="0" /> <description> Saves a resource to disk to the given path, using a [ResourceFormatSaver] that recognizes the resource object. - The [code]flags[/code] bitmask can be specified to customize the save behavior. + The [code]flags[/code] bitmask can be specified to customize the save behavior using [enum SaverFlags] flags. Returns [constant OK] on success. </description> </method> </methods> <constants> + <constant name="FLAG_NONE" value="0" enum="SaverFlags"> + No resource saving option. + </constant> <constant name="FLAG_RELATIVE_PATHS" value="1" enum="SaverFlags"> Save the resource with a path relative to the scene which uses it. </constant> |