class-description NEWS COMMUNITY STORE TUTORIALS SIGN UP LOGIN LOGOUT ROKOJORI NEWSLETTER SIGN UP LOGIN LOGOUT NEWS COMMUNITY STORE TUTORIALS TOGGLE FULLSCREEN VOLLBILD AN/AUS Object ResourceSaver
A singleton for saving Resources to the filesystem.

A singleton for saving resource types to the filesystem.

It uses the many ResourceFormatSaver classes registered in the engine (either built-in or from a plugin) to save resource data to text-based (e.g. .tres or .tscn) or binary files (e.g. .res or .scn).

 Enum SaverFlags<>():Enum

FLAG_NONE = 0

No resource saving option.


FLAG_RELATIVE_PATHS = 1

Save the resource with a path relative to the scene which uses it.


FLAG_BUNDLE_RESOURCES = 2

Bundles external resources.


FLAG_CHANGE_PATH = 4

Changes the Resource.resource_path of the saved resource to match its new location.


FLAG_OMIT_EDITOR_PROPERTIES = 8

Do not save editor-specific metadata (identified by their __editor prefix).


FLAG_SAVE_BIG_ENDIAN = 16

Save as big endian (see FileAccess.big_endian).


FLAG_COMPRESS = 32

Compress the resource on save using FileAccess.COMPRESSION_ZSTD. Only available for binary resource types.


FLAG_REPLACE_SUBRESOURCE_PATHS = 64

Take over the paths of the saved subresources (see Resource.take_over_path()).

 void add_resource_format_saver<>( ResourceFormatSaver format_saver=, format_saver:ResourceFormatSaver=, bool at_front=false, at_front:bool=false, ):void

Registers a new ResourceFormatSaver. The ResourceSaver will use the ResourceFormatSaver as described in save().

This method is performed implicitly for ResourceFormatSavers written in GDScript (see ResourceFormatSaver for more information).

 PackedStringArray get_recognized_extensions<>( Resource type=, type:Resource=, ):PackedStringArray

Returns the list of extensions available for saving a resource of a given type.

 int get_resource_id_for_path<>( String path=, path:String=, bool generate=false, generate:bool=false, ):int

Returns the resource ID for the given path. If generate is true, a new resource ID will be generated if one for the path is not found. If generate is false and the path is not found, ResourceUID.INVALID_ID is returned.

 void remove_resource_format_saver<>( ResourceFormatSaver format_saver=, format_saver:ResourceFormatSaver=, ):void

Unregisters the given ResourceFormatSaver.

 Error save<>( Resource resource=, resource:Resource=, String path="", path:String="", =, :=, ):Error

Saves a resource to disk to the given path, using a ResourceFormatSaver that recognizes the resource object. If path is empty, ResourceSaver will try to use Resource.resource_path.

The flags bitmask can be specified to customize the save behavior using SaverFlags flags.

Returns @GlobalScope.OK on success.

Note: When the project is running, any generated UID associated with the resource will not be saved as the required code is only executed in editor mode.


All social media brands are registrated trademarks and belong to their respective owners.





CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com We are using cookies on this site. Read more... Wir benutzen Cookies auf dieser Seite. Mehr lesen...