:github_url: hide .. _class_ResourceSaver: ResourceSaver ============= **Наследует:** :ref:`Object` Синглтон для сохранения :ref:`Resource`-ов в файловой системе. .. rst-class:: classref-introduction-group Описание ---------------- Синглтон для сохранения типов ресурсов в файловой системе. Он использует множество классов :ref:`ResourceFormatSaver`, зарегистрированных в движке (встроенных или из плагина), для сохранения данных ресурсов в текстовых (например, ``.tres`` или ``.tscn``) или двоичных файлах (например, ``.res`` или ``.scn``). .. rst-class:: classref-reftable-group Методы ------------ .. table:: :widths: auto +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_resource_format_saver`\ (\ format_saver\: :ref:`ResourceFormatSaver`, at_front\: :ref:`bool` = false\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_recognized_extensions`\ (\ type\: :ref:`Resource`\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_resource_id_for_path`\ (\ path\: :ref:`String`, generate\: :ref:`bool` = false\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_resource_format_saver`\ (\ format_saver\: :ref:`ResourceFormatSaver`\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`save`\ (\ resource\: :ref:`Resource`, path\: :ref:`String` = "", flags\: |bitfield|\[:ref:`SaverFlags`\] = 0\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`set_uid`\ (\ resource\: :ref:`String`, uid\: :ref:`int`\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Перечисления ------------------------ .. _enum_ResourceSaver_SaverFlags: .. rst-class:: classref-enumeration flags **SaverFlags**: :ref:`🔗` .. _class_ResourceSaver_constant_FLAG_NONE: .. rst-class:: classref-enumeration-constant :ref:`SaverFlags` **FLAG_NONE** = ``0`` Нет возможности экономии ресурсов. .. _class_ResourceSaver_constant_FLAG_RELATIVE_PATHS: .. rst-class:: classref-enumeration-constant :ref:`SaverFlags` **FLAG_RELATIVE_PATHS** = ``1`` Сохраните ресурс с путем относительно сцены, которая его использует. .. _class_ResourceSaver_constant_FLAG_BUNDLE_RESOURCES: .. rst-class:: classref-enumeration-constant :ref:`SaverFlags` **FLAG_BUNDLE_RESOURCES** = ``2`` Пакеты внешних ресурсов. .. _class_ResourceSaver_constant_FLAG_CHANGE_PATH: .. rst-class:: classref-enumeration-constant :ref:`SaverFlags` **FLAG_CHANGE_PATH** = ``4`` Изменяет :ref:`Resource.resource_path` сохраненного ресурса в соответствии с его новым местоположением. .. _class_ResourceSaver_constant_FLAG_OMIT_EDITOR_PROPERTIES: .. rst-class:: classref-enumeration-constant :ref:`SaverFlags` **FLAG_OMIT_EDITOR_PROPERTIES** = ``8`` Не сохраняйте метаданные, специфичные для редактора (идентифицируемые префиксом ``__editor``). .. _class_ResourceSaver_constant_FLAG_SAVE_BIG_ENDIAN: .. rst-class:: classref-enumeration-constant :ref:`SaverFlags` **FLAG_SAVE_BIG_ENDIAN** = ``16`` Сохранить как big endian (см. :ref:`FileAccess.big_endian`). .. _class_ResourceSaver_constant_FLAG_COMPRESS: .. rst-class:: classref-enumeration-constant :ref:`SaverFlags` **FLAG_COMPRESS** = ``32`` Сжимать ресурс при сохранении с помощью :ref:`FileAccess.COMPRESSION_ZSTD`. Доступно только для двоичных типов ресурсов. .. _class_ResourceSaver_constant_FLAG_REPLACE_SUBRESOURCE_PATHS: .. rst-class:: classref-enumeration-constant :ref:`SaverFlags` **FLAG_REPLACE_SUBRESOURCE_PATHS** = ``64`` Перенять пути сохраненных подресурсов (см. :ref:`Resource.take_over_path()`). .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Описания метода ------------------------------ .. _class_ResourceSaver_method_add_resource_format_saver: .. rst-class:: classref-method |void| **add_resource_format_saver**\ (\ format_saver\: :ref:`ResourceFormatSaver`, at_front\: :ref:`bool` = false\ ) :ref:`🔗` Регистрирует новый :ref:`ResourceFormatSaver`. ResourceSaver будет использовать ResourceFormatSaver, как описано в :ref:`save()`. Этот метод выполняется неявно для ResourceFormatSavers, написанных на GDScript (см. :ref:`ResourceFormatSaver` для получения дополнительной информации). .. rst-class:: classref-item-separator ---- .. _class_ResourceSaver_method_get_recognized_extensions: .. rst-class:: classref-method :ref:`PackedStringArray` **get_recognized_extensions**\ (\ type\: :ref:`Resource`\ ) :ref:`🔗` Возвращает список расширений, доступных для сохранения ресурса заданного типа. .. rst-class:: classref-item-separator ---- .. _class_ResourceSaver_method_get_resource_id_for_path: .. rst-class:: classref-method :ref:`int` **get_resource_id_for_path**\ (\ path\: :ref:`String`, generate\: :ref:`bool` = false\ ) :ref:`🔗` Возвращает идентификатор ресурса для указанного пути. Если ``generate`` равен ``true``, будет сгенерирован новый идентификатор ресурса, если он для пути не найден. Если ``generate`` равен ``false`` и путь не найден, возвращается :ref:`ResourceUID.INVALID_ID`. .. rst-class:: classref-item-separator ---- .. _class_ResourceSaver_method_remove_resource_format_saver: .. rst-class:: classref-method |void| **remove_resource_format_saver**\ (\ format_saver\: :ref:`ResourceFormatSaver`\ ) :ref:`🔗` Отменяет регистрацию указанного :ref:`ResourceFormatSaver`. .. rst-class:: classref-item-separator ---- .. _class_ResourceSaver_method_save: .. rst-class:: classref-method :ref:`Error` **save**\ (\ resource\: :ref:`Resource`, path\: :ref:`String` = "", flags\: |bitfield|\[:ref:`SaverFlags`\] = 0\ ) :ref:`🔗` Сохраняет ресурс на диске по указанному пути, используя :ref:`ResourceFormatSaver`, который распознает объект ресурса. Если ``path`` пуст, **ResourceSaver** попытается использовать :ref:`Resource.resource_path`. Можно указать битовую маску ``flags`` для настройки поведения сохранения. Возвращает :ref:`@GlobalScope.OK` при успешном выполнении. \ **Примечание:** Когда проект запущен, любой сгенерированный UID, связанный с ресурсом, не будет сохранен, поскольку требуемый код выполняется только в режиме редактора. .. rst-class:: classref-item-separator ---- .. _class_ResourceSaver_method_set_uid: .. rst-class:: classref-method :ref:`Error` **set_uid**\ (\ resource\: :ref:`String`, uid\: :ref:`int`\ ) :ref:`🔗` Устанавливает UID указанного пути ``resource`` на ``uid``. Вы можете сгенерировать новый UID с помощью :ref:`ResourceUID.create_id()`. Поскольку ресурсы обычно получают UID автоматически, этот метод полезен только в очень особых случаях. .. |virtual| replace:: :abbr:`virtual (Этот метод обычно должен быть переопределен пользователем, чтобы иметь какой-либо эффект.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (Этот метод не имеет побочных эффектов. Он не изменяет ни одну из переменных-членов экземпляра.)` .. |vararg| replace:: :abbr:`vararg (Этот метод принимает любое количество аргументов после описанных здесь.)` .. |constructor| replace:: :abbr:`constructor (Этот метод используется для создания типа.)` .. |static| replace:: :abbr:`static (Этот метод не нуждается в вызове экземпляра, поэтому его можно вызвать напрямую, используя имя класса.)` .. |operator| replace:: :abbr:`operator (Этот метод описывает допустимый оператор для использования с этим типом в качестве левого операнда.)` .. |bitfield| replace:: :abbr:`BitField (Это значение является целым числом, составленным как битовая маска следующих флагов.)` .. |void| replace:: :abbr:`void (Нет возвращаемого значения.)`