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

Serializable Types

Тип как обычное поле: Unity его сохраняет, а инспектор даёт выбрать из списка.

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

До — Unity APIПосле — FastTools
[SerializeField]
private string _primaryWeaponName;

public System.Type PrimaryWeapon =>
string.IsNullOrEmpty(
_primaryWeaponName)
? null
: System.Type.GetType(
_primaryWeaponName);
[TypeSelector(Allow = TypeAllow.None)]
[SerializeField]
private SerializableType<Weapon>
_primaryWeapon;

public System.Type PrimaryWeapon =>
_primaryWeapon;

[TypeSelector] задаёт настройки выбора: Allow = TypeAllow.None оставляет в списке только конкретные типы.

Выбор сериализуемого типа в инспектореВыбор сериализуемого типа в инспекторе

Что выбрать​

ЗадачаПоле
Хранить тип, в том числе из DLL, вложенный или genericSerializableType, SerializableType<T>
Сохранить выбор при переименовании собственного скриптаSerializableMonoScript, SerializableMonoScript<T>

Вариант с T предлагает в окне выбора только типы, совместимые с T.

SerializableType​

SerializableType хранит assembly-qualified name — имя типа вместе со сборкой. Значение по умолчанию задают в коде:

[SerializeField]
private SerializableType<Weapon> _primaryWeapon = new(typeof(Sword));

Обёртки с одним именем типа равны между собой, поэтому подходят в ключи Dictionary и HashSet. Так же ведёт себя SerializableMonoScript; оператор == сравнивает ссылки.

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

После переименования класса, namespace или сборки сохранённое имя больше не находится: поле показывает <Missing …>, а под ним появляется Missing type. В подписи указано имя типа без сборки, во всплывающей подсказке — сохранённое имя целиком.

  • .Type возвращает null.
  • AssemblyQualifiedName и ToString() сохраняют прежнее имя.

Потерянный тип Game.Combat.Spear с кнопками Fix и → SpearПотерянный тип Game.Combat.Spear с кнопками Fix и → Spear

Fix открывает окно выбора, и выбранный тип заменяет сохранённое имя. Если класс только перенесли в другой namespace или сборку и подходящий тип с таким именем один, уведомление предлагает его сразу, например → Spear. Уведомление сравнивает только имена классов, а [MovedFrom] не читает, поэтому для класса, переименованного с этим атрибутом, подсказки нет: выберите новый класс через Fix.

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

Пустое поле​

Незаполненное поле проверяйте через field is null || field.IsEmpty, а не через один field == null:

  • У объекта, загруженного из ассета, сцены или префаба, в поле лежит обёртка, пустая, если ничего не выбрано.
  • У объекта, созданного в коде (AddComponent, ScriptableObject.CreateInstance), поле равно null, пока Unity не сериализует объект.

Состояния обёртки различают IsEmpty и IsMissing:

СостояниеTypeIsEmptyIsMissing
Тип выбрантипfalsefalse
Ничего не выбраноnulltruefalse
Сохранённое имя больше не находится, потерянный типnullfalsetrue

SerializableMonoScript​

SerializableMonoScript помнит сам ассет скрипта, поэтому выбор переживает его переименование. Тип выбирают в инспекторе или перетаскивают файл .cs из Project на поле.

После переименования Sword.cs → Blade.csSerializableTypeSerializableMonoScript
.Typenull — потерянный типBlade, в Play Mode тоже
Сохранённое имяSwordBlade, как только ассет пересохранят

Ограничения:

  • выбрать можно только класс верхнего уровня, не generic: объявленный в .cs с тем же именем либо производный от MonoBehaviour или ScriptableObject в DLL;
  • публичного конструктора нет, из кода поле не создать.

Связь с классом теряется, а поле показывает потерянный тип с тем же уведомлением, если:

  • класс переименовали без файла;
  • файл переименовали вне Unity без .meta;
  • класс из DLL переименовали или перенесли в другой namespace: Unity определяет его ассет скрипта по namespace и имени класса.

Типы в плеере​

внимание

В плеере обе обёртки находят тип по сохранённому имени. Если класс используется только через такой выбор, при Managed Stripping Level Medium или High Unity вырезает его из билда: .Type вернёт null, а IsMissing станет true, хотя в редакторе тип находится. Minimal и Low его сохраняют.

Чтобы сохранить класс при Medium или High:

  • Пометьте класс или его конструктор атрибутом [Preserve] (UnityEngine.Scripting).
  • Перечислите класс или всю его сборку в link.xml.
  • Пометьте свой интерфейс атрибутом [RequireImplementors], а свой базовый класс — [RequireDerived], чтобы сохранить все реализации: поле должно быть SerializableType<T> этого интерфейса или базового класса.

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

Выбор типов врагов и паттерна расстановки показан в примере Types.

Волна обычных и элитных врагов в сцене TypesВолна обычных и элитных врагов в сцене Types