Перейти к основному содержимому

SerializeReference Selector

Класс поля выбирают в инспекторе, а данные не теряются при его смене.

Быстрый старт​

До — Unity APIПосле — FastTools
[SerializeReference]
private IWeapon _primary =
new Pistol();
[TypeSelector]
[SerializeReference]
private IWeapon _primary;

Какие классы в списке​

Поле IWeapon предлагает конкретные реализации этого интерфейса, например Pistol и Shotgun. Выбор создаёт экземпляр класса; <None> очищает поле.

Дополнительные ограничения, обязательные поля и оформление списка — на странице TypeSelector.

  • Allow здесь не действует: нужны типы, экземпляры которых можно создать.
  • Классов, производных от UnityEngine.Object, в списке нет: такой объект храните в обычном поле, без [SerializeReference].
  • Аргументы generic-класса выводятся из типа поля и типов [TypeSelector]; если вывести их нельзя, окно предлагает выбрать типы, которые Unity умеет сериализовать.

Списки​

В списке с [TypeSelector] кнопка «+» открывает выбор класса и добавляет новый экземпляр, а <None> — пустой элемент. При нескольких выбранных объектах каждый получает свой экземпляр.

«+» у Sidearms открывает выбор класса и добавляет Shotgun«+» у Sidearms открывает выбор класса и добавляет Shotgun

Смена класса​

При смене класса FastTools пытается перенести совместимые значения полей с теми же именами. Поля, которые перенести не удалось, остаются со значениями нового экземпляра:

ПолеPistol→ Shotgun
Damage3737
Magazine Size12—
Pellets—8, начальное значение

Смена Pistol на Shotgun сохраняет Damage = 37Смена Pistol на Shotgun сохраняет Damage = 37

Вложенная ссылка переносится тем же экземпляром, если имя и тип поля совместимы.

подсказка

Класс можно выбрать, перетащив .cs из Project на заголовок поля.

Меню заголовка​

Правый клик по заголовку поля:

ПунктЧто делает
RevertНа экземпляре префаба возвращает поле с изменённым классом или данными к классу и данным префаба; подпись такого поля жирная. Изменение внутри вложенной ссылки отмечает только изменённое поле
Apply to Prefab 'Player'На экземпляре префаба записывает такое поле в префаб; не предлагается у варианта префаба, выбранного в Project
Copy Serialize ReferenceКопирует класс и данные поля; копия живёт до перезагрузки домена
Paste Serialize ReferenceВставляет копию в поле подходящего типа; копия пустого поля очищает его
Find Usages of PistolИщет класс в проекте через Unity Search
Create New Script…Создаёт [Serializable] класс под тип поля и назначает его после компиляции
Save as Template…Сохраняет значение под именем; шаблоны хранятся в настройках редактора на этом компьютере, не в проекте
Paste Template → …Создаёт экземпляр из шаблона; в списке только подходящие полю
Paste Template → Remove Missing (N)…Удаляет шаблоны, класс которых больше не загружается; появляется, только если такие есть
внимание

Copy/Paste и шаблоны не переносят вложенные поля [SerializeReference]: вставленный объект потеряет такие ссылки.

Общие ссылки​

Link to Existing → … в меню заголовка связывает поле с экземпляром из другого поля того же объекта.

Поля, которые указывают на один экземпляр, помечены Shared reference #N, а Make unique под полем или Make Unique Reference в меню заголовка даёт полю собственную копию вместе с вложенными ссылками.

Make unique создаёт независимую копию общей ссылкиMake unique создаёт независимую копию общей ссылки

Продублированный элемент списка получает собственный экземпляр, а не ссылку на тот же. За это отвечает настройка Auto de-alias duplicated list elements в Tools → Aspid 🐍 → FastTools → Settings, по умолчанию она включена и общая для команды.

Это работает для списков, элементы которых сами являются ссылками, например List<IWeapon>. В списке структур или классов с полем или списком [SerializeReference] Duplicate Array Element копирует и ссылку, поэтому оба элемента указывают на один экземпляр, пока Make unique их не разделит.

Потерянный тип​

После переименования, переноса или удаления класса поле показывает <Missing …>, а под ним появляется Missing type. Данные поля при этом остаются в ассете.

Потерянная ссылка Game.Gear.Pistoll с кнопками Fix и → PistolПотерянная ссылка Game.Gear.Pistoll с кнопками Fix и → Pistol

Fix открывает выбор класса, и выбранный класс заменяет потерянный. Уведомление может сразу предложить подходящий класс, например → Pistol; причину показывает подсказка. Что Fix сохраняет на ассете и в сцене, описано в разделе Fix в инспекторе.

Все потерянные ссылки в проекте находит Project References и восстанавливает их группами. О новых потерях сообщают проверка перед сборкой и обнаружение новых поломок.

Собственный инспектор​

Поле с [TypeSelector] в своём редакторе рисует обычный PropertyField — в UI Toolkit и в IMGUI: выбор класса и «+» списка появляются сами. Если элемент списка рисуется отдельно, используйте SerializeReferenceEditorGUI или SerializeReferenceIMGUIList.

Пример в пакете​

Выбор оружия, списки и вложенные ссылки показаны в примере SerializeReferences.

Манекен получает урон в сцене SerializeReferencesМанекен получает урон в сцене SerializeReferences