ResourceSaver
Hereda: Object
Un singleton para guardar Resources en el sistema de archivos.
Descripción
Un singleton para guardar tipos de recursos en el sistema de archivos.
Utiliza las muchas clases ResourceFormatSaver registradas en el motor (ya sea integrado o de un plugin) para guardar datos de recursos en archivos basados en texto (p. ej. .tres o .tscn) o archivos binarios (p. ej. .res o .scn).
Métodos
void |
add_resource_format_saver(format_saver: ResourceFormatSaver, at_front: bool = false) |
get_resource_id_for_path(path: String, generate: bool = false) |
|
void |
remove_resource_format_saver(format_saver: ResourceFormatSaver) |
save(resource: Resource, path: String = "", flags: BitField[SaverFlags] = 0) |
|
Enumeraciones
flags SaverFlags: 🔗
SaverFlags FLAG_NONE = 0
No hay opción de guardado de recursos.
SaverFlags FLAG_RELATIVE_PATHS = 1
Guarda el recurso con una ruta relativa a la escena que lo utiliza.
SaverFlags FLAG_BUNDLE_RESOURCES = 2
Agrupa los recursos externos.
SaverFlags FLAG_CHANGE_PATH = 4
Cambia la Resource.resource_path del recurso guardado para que coincida con su nueva ubicación.
SaverFlags FLAG_OMIT_EDITOR_PROPERTIES = 8
No guarde los metadatos específicos del editor (identificados por su prefijo __editor).
SaverFlags FLAG_SAVE_BIG_ENDIAN = 16
Guardar como big endian (véase FileAccess.big_endian).
SaverFlags FLAG_COMPRESS = 32
Comprime el recurso al guardarlo usando FileAccess.COMPRESSION_ZSTD. Solo disponible para tipos de recursos binarios.
SaverFlags FLAG_REPLACE_SUBRESOURCE_PATHS = 64
Asumir las rutas de los subrecursos guardados (véase Resource.take_over_path()).
Descripciones de Métodos
void add_resource_format_saver(format_saver: ResourceFormatSaver, at_front: bool = false) 🔗
Registra un nuevo ResourceFormatSaver. ResourceSaver usará el ResourceFormatSaver como se describe en save().
Este método se realiza implícitamente para los ResourceFormatSavers escritos en GDScript (consulta ResourceFormatSaver para obtener más información).
PackedStringArray get_recognized_extensions(type: Resource) 🔗
Devuelve la lista de extensiones disponibles para guardar un recurso de un tipo determinado.
int get_resource_id_for_path(path: String, generate: bool = false) 🔗
Devuelve el ID del recurso para la ruta dada. Si generate es true, se generará un nuevo ID de recurso si no se encuentra uno para la ruta. Si generate es false y no se encuentra la ruta, se devuelve ResourceUID.INVALID_ID.
void remove_resource_format_saver(format_saver: ResourceFormatSaver) 🔗
Anula el registro del ResourceFormatSaver indicado.
Error save(resource: Resource, path: String = "", flags: BitField[SaverFlags] = 0) 🔗
Guarda un recurso en el disco en la ruta dada, utilizando un ResourceFormatSaver que reconoce el objeto de recurso. Si path está vacío, ResourceSaver intentará utilizar Resource.resource_path.
La máscara de bits flags se puede especificar para personalizar el comportamiento de guardado.
Devuelve @GlobalScope.OK si tiene éxito.
Nota: Cuando el proyecto se está ejecutando, cualquier UID generado asociado con el recurso no se guardará, ya que el código requerido solo se ejecuta en modo editor.
Error set_uid(resource: String, uid: int) 🔗
Establece el UID de la resource ruta dada a uid. Puedes generar un nuevo UID usando ResourceUID.create_id().
Dado que los recursos normalmente obtendrán un UID automáticamente, este método solo es útil en casos muy específicos.