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 ObjectRefCounted ResourceFormatLoader
Loads a specific resource type from a file.

Godot loads resources in the editor or in exported games using ResourceFormatLoaders. They are queried automatically via the ResourceLoader singleton, or when a resource with internal dependencies is loaded. Each file type may load as a different resource type, so multiple ResourceFormatLoaders are registered in the engine.

Extending this class allows you to define your own loader. Be sure to respect the documented return types and values. You should give it a global class name with class_name for it to be registered. Like built-in ResourceFormatLoaders, it will be called automatically when loading resources of its handled type(s). You may also implement a ResourceFormatSaver.

 Enum CacheMode<>():Enum

CACHE_MODE_IGNORE = 0

There is currently no description for this enum. Please help us by contributing one!


CACHE_MODE_REUSE = 1

There is currently no description for this enum. Please help us by contributing one!


CACHE_MODE_REPLACE = 2

There is currently no description for this enum. Please help us by contributing one!

 bool _exists<>( String path=, path:String=, ):bool

There is currently no description for this method. Please help us by contributing one!

 PackedStringArray _get_classes_used<>( String path=, path:String=, ):PackedStringArray

There is currently no description for this method. Please help us by contributing one!

 PackedStringArray _get_dependencies<>( String path=, path:String=, bool add_types=, add_types:bool=, ):PackedStringArray

If implemented, gets the dependencies of a given resource. If add_types is true, paths should be appended ::TypeName, where TypeName is the class name of the dependency.

Note: Custom resource types defined by scripts aren't known by the ClassDB, so you might just return "Resource" for them.

 PackedStringArray _get_recognized_extensions<>():PackedStringArray

Gets the list of extensions for files this loader is able to read.

 String _get_resource_script_class<>( String path=, path:String=, ):String

Returns the script class name associated with the Resource under the given path. If the resource has no script or the script isn't a named class, it should return "".

 String _get_resource_type<>( String path=, path:String=, ):String

Gets the class name of the resource associated with the given path. If the loader cannot handle it, it should return "".

Note: Custom resource types defined by scripts aren't known by the ClassDB, so you might just return "Resource" for them.

 int _get_resource_uid<>( String path=, path:String=, ):int

There is currently no description for this method. Please help us by contributing one!

 bool _handles_type<>( StringName type=, type:StringName=, ):bool

Tells which resource class this loader can load.

Note: Custom resource types defined by scripts aren't known by the ClassDB, so you might just handle "Resource" for them.

 Variant _load<>( String path=, path:String=, String original_path=, original_path:String=, bool use_sub_threads=, use_sub_threads:bool=, int cache_mode=, cache_mode:int=, ):Variant

Loads a resource when the engine finds this loader to be compatible. If the loaded resource is the result of an import, original_path will target the source file. Returns a Resource object on success, or an Error constant in case of failure.

The cache_mode property defines whether and how the cache should be used or updated when loading the resource. See CacheMode for details.

 bool _recognize_path<>( String path=, path:String=, StringName type=, type:StringName=, ):bool

Tells whether or not this loader should load a resource from its resource path for a given type.

If it is not implemented, the default behavior returns whether the path's extension is within the ones provided by _get_recognized_extensions, and if the type is within the ones provided by _get_resource_type.

 Error _rename_dependencies<>( String path=, path:String=, Dictionary renames=, renames:Dictionary=, ):Error

If implemented, renames dependencies within the given resource and saves it. renames is a dictionary { String => String } mapping old dependency paths to new paths.

Returns @GlobalScope.OK on success, or an Error constant in case of failure.


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...