Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

ResourceFormatLoader

Inherits: Reference < Object

Carga un tipo de recurso específico de un archivo.

Descripción

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.

Note: You can also extend EditorImportPlugin if the resource type you need exists but Godot is unable to load its format. Choosing one way over another depends on if the format is suitable or not for the final exported game. For example, it's better to import .png textures as .stex (StreamTexture) first, so they can be loaded with better efficiency on the graphics card.

Métodos

void

get_dependencies ( String path, String add_types ) virtual

PoolStringArray

get_recognized_extensions ( ) virtual

String

get_resource_type ( String path ) virtual

bool

handles_type ( String typename ) virtual

Variant

load ( String path, String original_path ) virtual

int

rename_dependencies ( String path, String renames ) virtual

Descripciones de Métodos

  • void get_dependencies ( String path, String add_types ) virtual

Si se aplica, obtiene las dependencias de un recurso determinado. Si add_types es true, las rutas deben ser anexadas ::TypeName, donde TypeName es el nombre de la clase de la dependencia.

Nota: Los tipos de recursos personalizados definidos por los scripts no son conocidos por la ClassDB, por lo que sólo se puede devolver "Resource" por ellos.

Obtiene la lista de extensiones de los archivos que este cargador es capaz de leer.

Obtiene el nombre de la clase del recurso asociado con el camino dado. Si el cargador no puede manejarlo, debe devolver ".

Nota: Los tipos de recursos personalizados definidos por los scripts no son conocidos por el ClassDB, por lo que debería devolver "Resource" por ellos.

Dice qué clase de recursos puede cargar este cargador.

Nota: Los tipos de recursos personalizados definidos por los scripts no son conocidos por la ClassDB, por lo que sólo puedes manejar "Resource" para ellos.

Carga un recurso cuando el motor encuentra que este cargador es compatible. Si el recurso cargado es el resultado de una importación, original_path se dirigirá al archivo fuente. Devuelve un objeto Resource en caso de éxito, o una constante Error en caso de fracaso.

Si se implementa, renombra las dependencias dentro del recurso dado y lo guarda. renambes es un diccionario { String => String } que mapea las antiguas rutas de dependencia a las nuevas rutas.

Devuelve @GlobalScope.OK en caso de éxito, o una constante Error en caso de fracaso.