Инструменты редактора Unity: отменяемые изменения и переопределения префабов

Рассматривайте действие редактора как изменение создаваемых данных

Полезный инструмент редактора должен ясно отвечать, что изменил пользователь и какому объекту принадлежит изменение. Обновление Inspector, изменение сериализованного состояния, создание записи Undo и сохранение файла — разные обязанности. Определите цель и ожидаемый результат до добавления удобной кнопки. Описанное поведение API следует указанным справочникам Unity 6.0. [1][2][3]

Предпочитайте сериализованные свойства

SerializedObject и SerializedProperty предоставляют поток редактирования сериализованных полей и интегрируют изменения с Undo и переопределениями префабов. Для сохраняемого потока вызывайте Update перед чтением актуальных значений, меняйте нужные свойства и переносите изменения через ApplyModifiedProperties. Отдельные потоки для одних и тех же объектов требуют синхронизации. [1]

Выполняйте изменение только по реальному действию пользователя. Повторная отрисовка Inspector сама по себе не должна постоянно менять авторские значения. Также явно проверяйте данные: применение сериализованных полей не запускает логику проверки соответствующего сеттера свойства C#. [1]

Сделайте конкретный инструмент пусковых устройств предсказуемым

Представьте компонент пускового устройства с сериализованным полем launchSpeed. Кнопка устанавливает выбранным устройствам значение 9 единиц проекта в секунду вместо текущих значений. У конкретного экземпляра префаба в сцене раньше было значение 6. Ожидаемый результат — переопределение экземпляра, которое можно отменить до прежнего значения, тогда как исходный префаб сохраняет своё значение по умолчанию.

Ясно задайте область действия кнопки. Присвоение всем выбранным устройствам одинакового значения отличается от прибавления величины к прежнему значению каждого. Геттер сериализованного свойства для нескольких объектов возвращает значение первого объекта, поэтому однократное чтение с последующей общей арифметикой не реализует независимые относительные изменения. [1]

Записывайте прямые изменения в правильном порядке

Если инструмент напрямую меняет свойства объекта, вызовите Undo.RecordObject для изменяемого объекта до присвоения новых значений. Для экземпляра префаба после изменения вызовите PrefabUtility.RecordPrefabInstancePropertyModifications, чтобы записать переопределение. Unity рекомендует сериализованный процесс, когда он подходит для правки. [2][3]

Записывайте настоящий компонент или объект-владелец, а не постороннюю обёртку выбора. Этот API записи свойств не охватывает смену родителя transform, добавление компонента или уничтожение объекта: им нужны специализированные функции Undo. Не расширяйте работающий редактор скалярного значения в предположении, что у любой структурной операции тот же контракт записи. [2]

Проверяйте Undo и сохранение отдельно

Для примера пускового устройства проверьте новое значение, Undo, Redo и видимое переопределение префаба. Сохраните и заново откройте сцену, чтобы изучить сохранённый результат, а также проверьте исходный префаб для подтверждения нужной области изменений. Повторите с несколькими выбранными объектами, имеющими разные начальные значения.

Эти проверки отвечают на разные вопросы: произошло ли редактирование, можно ли восстановить предыдущее состояние и сохраняется ли нужное авторское состояние после повторного открытия. Предлагаемая проверка здесь не выполнялась. Не предполагайте, что обычная запись Undo для свойств восстановит изменения внешних файлов и другие несериализованные побочные эффекты.

Источники

1. SerializedObject — Unity Technologies.
2. Undo.RecordObject — Unity Technologies.
3. PrefabUtility.RecordPrefabInstancePropertyModifications — Unity Technologies.