reckfellENGINE

ResourceFormatSaver

Обработчик записи собственного формата ресурсов.

На этой странице
class ResourceFormatSaverReckfellSharpНаследует RefCounted

Реализуйте подкласс C# с _Recognize, _GetRecognizedExtensions и _Save. Зарегистрируйте экземпляр через ResourceSaver.AddResourceFormatSaver до Save; снимите регистрацию до Dispose. Объявление класса само по себе не заменяет этот жизненный цикл.

ResourceSaver выбирает обработчик по объекту и пути. _Save должен записать данные и вернуть достоверный Error. Флаги, зависимости, UID, атомарная замена и резервные копии не реализуются за вас.

Методы с подчёркиванием предназначены для переопределения. Для обычного сохранения вызывайте ResourceSaver.Save. Описанные значения при отсутствии переопределений относятся к нативному обработчику.

собственный формат ресурсов: полный исполняемый пример C#.

Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.

Конструкторы1

ResourceFormatSaverКонструктор
# ResourceFormatSaver
C#
public ResourceFormatSaver();

Создаёт незарегистрированный обработчик сохранения. Реализуйте подкласс и зарегистрируйте экземпляр в ResourceSaver до Save.

Методы5

_GetRecognizedExtensionsstring[]
# _GetRecognizedExtensions
C#
public virtual string[] _GetRecognizedExtensions(Resource resource);

Перечисляет расширения для сохранения конкретного объекта. Согласуйте результат с _Recognize и не заявляйте расширения для неподдерживаемого типа.

Параметры
ИмяТипПо умолчанию
resourceResource—
resource

Объект для проверки или сохранения. Проверяйте конкретный поддерживаемый тип, а не только наследование от Resource.

Возвращает string[]

Массив расширений без точки; пустой массив не предоставляет расширений для стандартного выбора.

_Recognizebool
# _Recognize
C#
public virtual bool _Recognize(Resource resource);

Проверяет поддержку объекта этим saver по его типу и возможностям формата. Путь отдельно проверяется через _RecognizePath. Без переопределения нативный обработчик возвращает false.

Параметры
ИмяТипПо умолчанию
resourceResource—
resource

Объект для проверки или сохранения. Проверяйте конкретный поддерживаемый тип, а не только наследование от Resource.

Возвращает bool

true для поддерживаемого объекта. Успешная запись и доступность файла этим не подтверждаются.

_RecognizePathbool
# _RecognizePath
C#
public virtual bool _RecognizePath(Resource resource, string path);

Проверяет поддержку пути сохранения для объекта. Без переопределения нативная реализация сравнивает расширение без учёта регистра с _GetRecognizedExtensions(resource). Переопределение заменяет эту проверку; выбор формата ещё не открывает файл.

Параметры
ИмяТипПо умолчанию
resourceResource—
pathstring—
resource

Объект для проверки или сохранения. Проверяйте конкретный поддерживаемый тип, а не только наследование от Resource.

path

Путь файла собственного формата: логический asset:// или user:// согласно месту хранения.

Возвращает bool

true, если путь подходит формату. Это выбор обработчика, не проверка содержимого или прав доступа.

_SaveError
# _Save
C#
public virtual Error _Save(Resource resource, string path, uint flags);

Записывает объект в собственном формате и возвращает Error. Проверяйте открытие, сериализацию и запись; не возвращайте Ok после отказа. Флаги, атомарная замена и резервные копии не реализуются автоматически.

Параметры
ИмяТипПо умолчанию
resourceResource—
pathstring—
flagsuint—
resource

Объект для проверки или сохранения. Проверяйте конкретный поддерживаемый тип, а не только наследование от Resource.

path

Путь файла собственного формата: логический asset:// или user:// согласно месту хранения.

flags

Битовая маска ResourceSaver.SaverFlags. Реализуйте подходящие формату флаги или явно отклоните неподдерживаемые.

Возвращает Error

Error.Ok после успешной записи либо код отказа. Без переопределения нативный обработчик возвращает MethodNotFound.

_SetUidError
# _SetUid
C#
public virtual Error _SetUid(string path, long uid);

Обновляет UID, сохранённый внутри файла собственного формата. Это отдельная операция от _Save и не переименование пути. Без переопределения нативный обработчик возвращает FileUnrecognized.

Параметры
ИмяТипПо умолчанию
pathstring—
uidlong—
path

Путь файла собственного формата: логический asset:// или user:// согласно месту хранения.

uid

Новый числовой UID ресурса. Сохраните его способом, который понимает соответствующий загрузчик формата.

Возвращает Error

Error.Ok после изменения UID либо конкретный Error при отказе или неподдерживаемом формате.

Документация Reckfell EngineНаверх ↑
БЫСТРЫЙ ПЕРЕХОДНачало работыEntity и иерархияC# & .NET 10Сцены и префабы
Руководства и полный API Reckfell K
reckfellENGINE
RECKFELL ACCOUNT

Вход в аккаунт

Войдите в аккаунт Reckfell.

Один аккаунт для всей платформы Reckfell.