- Атрибут Unity [SerializeField]
- SerializeField
- Успех!
- Ошибка внесения изменений
- Описание
- SerializeField
- Success!
- Submission failed
- Description
- Русские Блоги
- Как понять функцию [SerializeField] сериализации в редакторе Unity
- Вопрос по требованию к оформлению кода при работе с Unity. public или [SerializeField]private
- 1 ответ 1
Атрибут Unity [SerializeField]
Добрый день, понимаю, что по-поводу этого атрибута в сети много статей и информации в целом, однако я не понял одного момента и поэтому я хотел бы его прояснить.
Этот атрибут делает переменные видимыми в редакторе, ну в основном его только для этого и используют. Однако понятие сериализация переводится как «перевести в биты» и я либо чего-то не понимаю, либо как перевод в биты влияет на то, что переменные начинают показываться в редакторе?
Сериализация — это перевод в биты. Эти биты нужно где-то хранить, например на диске. В юнити это работает примерно так: данные записываются на диск и в случае необходимости могут быть изменены И эти изменения сохраняются снова на диске (если это не playMode). На сколько я понимаю, редактор юнити отображает только сериализованные данные, по это причине их и сериализуют.
Да, Unity показывает в стандартном инспекторе только те поля, которые сериализирует.
Сериализацию можно понимать как процесс приведения кучи разнотипных данных к какому-то единому виду (перевести в поток битов/байтов, в xml, в json, ещё во что-нибудь), для того чтобы куда-то записать/сохранить или передать по сети. Потом над полученным потоком данных можно провести обратное действие — десериализацию — и получить назад данные в исходном виде.
По умолчанию Unity сериализирует только public поля. Если хочется, чтобы сериализировались поля и с другими модификаторами доступа, надо таким полям добавлять атрибут SerializeField.
1. Ты меняешь что-то в коде.
2. Unity перекомпилирует код.
3. Сериализирует всё что может и сохраняет полученные данные на диск.
4. Выгружает старый работающий код.
5. Загружает только что скомпилированный новый код.
6. Десериализирует сохранённые на диске данные и восстанавливает старые значения полей у всех компонентов.
1. Ты нажимаешь Play.
2. Unity сериализирует всё что может и сохраняет данные на диск.
3. В режиме Play меняешь значения каких-то полей или они меняются сами программно.
4. Нажимаешь Stop.
5. Unity десериализирует сохранённые данные и восстанавливает старые значения полей, как они были до нажатия на Play.
Для своих компонентов можно написать свой инспектор, который будет показывать любые поля; но просто у тех полей, которые в Unity не сериализируются, значения будут обнуляться после каждой перекомпиляции кода или выхода из режима Play. Это будет неинтуитивно и неудобно, поэтому логично, что такие поля Unity просто не показывает в инспекторе.
Источник
SerializeField
class in UnityEngine
Успех!
Благодарим вас за то, что вы помогаете нам улучшить качество документации по Unity. Однако, мы не можем принять любой перевод. Мы проверяем каждый предложенный вами вариант перевода и принимаем его только если он соответствует оригиналу.
Ошибка внесения изменений
По определённым причинам предложенный вами перевод не может быть принят. Пожалуйста попробуйте снова через пару минут. И выражаем вам свою благодарность за то, что вы уделяете время, чтобы улучшить документацию по Unity.
Описание
Force Unity to serialize a private field.
You will almost never need this. When Unity serializes your scripts, it will only serialize public fields. If in addition to that you also want Unity to serialize one of your private fields you can add the SerializeField attribute to the field.
Unity will serialize all your script components, reload the new assemblies, and recreate your script components from the serialized verions. This serialization does not happen with .NET’s serialization functionality, but with an internal Unity one.
The serialization system used can do the following:
— CAN serialize public nonstatic fields (of serializable types)
— CAN serialize nonpublic nonstatic fields marked with the [SerializeField] attribute.
— CANNOT serialize static fields.
— CANNOT serialize properties.
Your field will only serialize if it is of a type that Unity can serialize:
Serializable types are:
— All classes inheriting from UnityEngine.Object, for example GameObject, Component, MonoBehaviour, Texture2D, AnimationClip.
— All basic data types like int, string, float, bool.
— Some built-in types like Vector2, Vector3, Vector4, Quaternion, Matrix4x4, Color, Rect, LayerMask.
— Arrays of a serializable type
— List of a serializable type)
— Enums
— Structs
Note: if you put one element in a list (or array) twice, when the list gets serialized, you’ll get two copies of that element, instead of one copy being in the new list twice.
Hint: Unity won’t serialize Dictionary, however you could store a List<> for keys and a List<> for values, and sew them up in a non serialized dictionary on Awake(). This doesn’t solve the problem of when you want to modify the dictionary and have it «saved» back, but it is a handy trick in a lot of other cases.
For UnityScript users: Fields in c# is a script variable in UnityScript, and [SerializeField] becomes @SerializeField. [Serializable] on a class becomes @script Serializable in a UnityScript.
Источник
SerializeField
class in UnityEngine
Success!
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
Submission failed
For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
Description
Force Unity to serialize a private field.
When Unity serializes your scripts, it only serializes public fields. If you also want Unity to serialize your private fields you can add the SerializeField attribute to those fields.
Unity serializes all your script components, reloads the new assemblies, and recreates your script components from the serialized versions. This serialization is done with an internal Unity serialization system; not with .NET’s serialization functionality.
The serialization system can do the following:
- CAN serialize public non-static fields (of serializable types)
- CAN serialize nonpublic non-static fields marked with the SerializeField attribute.
- CANNOT serialize static fields.
- CANNOT serialize properties.
Serializable types
Unity can serialize fields of the following types:
- All classes inheriting from UnityEngine.Object, for example GameObject, Component, MonoBehaviour, Texture2D, AnimationClip.
- All basic data types, such as int, string, float, bool.
- Some built-in types, such as Vector2, Vector3, Vector4, Quaternion, Matrix4x4, Color, Rect, LayerMask.
- Arrays of a serializable type
- Lists of a serializable type
- Enums
- Structs
For more information on serialization, see Script Serialization.
Note: If you put one element in a list (or array) twice, when the list gets serialized, you’ll get two copies of that element, instead of one copy being in the new list twice.
Note: If you want to serialize a custom Struct field, you must give the Struct the [System.Serializable] attribute.
Hint: Unity won’t serialize Dictionary, however you could store a List<> for keys and a List<> for values, and sew them up in a non serialized dictionary on Awake(). This doesn’t solve the problem of when you want to modify the dictionary and have it «saved» back, but it is a handy trick in a lot of other cases.
Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.
Copyright ©2021 Unity Technologies. Publication Date: 2021-10-16.
Источник
Русские Блоги
Как понять функцию [SerializeField] сериализации в редакторе Unity
Ранее я не понимал характеристики сериализации и [SerializeField] (если вы не так поняли, пожалуйста, исправьте меня)
Что такое сериализация в первую очередь, Baidu объясняет следующим образом
Сериализация (сериализация) Процесс преобразования информации о состоянии объекта в форму, которая может быть сохранена или передана. Во время сериализации объект записывает свое текущее состояние во временное или постоянное хранилище. Вы можете воссоздать объект позже, прочитав или десериализовав состояние объекта из хранилища.
Понятно, что при воспроизведении игры сохранения сохраненная информация об игроке будет сохранена в файл. Когда вы в следующий раз откроете игру, чтобы прочитать сохранение, вы сможете продолжить играть из сохраненного состояния.
То же самое верно для редактора Unity. Значение открытого публичного свойства отображается на панели свойств. Мы можем произвольно изменить значение (соответствующее значение в скрипте не изменилось). Когда мы закрываем редактор Unity и открываем его снова, значение свойства является тем, которое мы изменили. Значение, а не начальное значение, назначенное в сценарии, указывающее, что значение атрибута «заархивировано»
Место хранения — файл сцены Unity, откройте его в Блокноте для просмотра соответствующей информации.
Прежде всего, редактор Unity — это программное обеспечение
Когда public int a = 0; создается в скрипте
Мы можем назначить свойство в Инспекторе (например, назначить 2)
Закрываем редактор Unity
При повторном открытии редактора значение a равно 2
Обратите внимание, что редактор Unity сериализировал общедоступные свойства (то есть измененные значения записываются аналогично архивированию)
Принудить единство, чтобы десериализовать частный домен. Это функция сериализации внутреннего единства. Иногда нам нужно сериализовать частное или защищенное свойство.
Источник
Вопрос по требованию к оформлению кода при работе с Unity. public или [SerializeField]private
Я столкнулся с дилеммой по поводу оформления. У меня есть скрипт который отвечает за обновление GUI инвентаря игрока, соответственно, есть и поля в которые передаётся текст, который мы, непосредственно, и будем обновлять. Стоит ли сделать это поле [SerializeField]private , так как нигде оно больше не используется, кроме как в этом скрипте, или оставить public , что, как мне кажется, смотрится лаконично (такой себе аргумент). Буду рад ссылке которая более подробнее расскажет об оформлении кода. Заранее спасибо за ответы, не судите строго, от части данный вопрос был задан что бы получше познакомится с площадкой stackoverflow.
1 ответ 1
Как уже написал EvgeniyZ в комментариях к вопросу
Модификаторы доступа относятся к инкапсуляции, но не к «оформлению».
Понять как лучше оформлять код помогут конвенции, например от Microsoft по C# и общие рекомендации по именованию.
Что касается [SerializeField], то этот атрибут указывает Unity что отмеченное поле класса нужно сериализовать, даже если оно приватное. (Более подробно про SerializeField и другие атрибуты используемые в Unity можно почитать в официальной документации Unity)
Unity использует сериализацию, в часности, для удобной работы в редакторе — сохранение и настройка префабов через изменение полей классов. Сюда относится и инъекция зависимостей(прокидывание ссылок, проще говоря. Именно это и подразумевается в коде в Вашем вопросе).
И теперь ответ на вопрос
У меня есть скрипт который отвечает за обновление GUI инвентаря игрока, соответственно, есть и поля в которые передаётся текст, который мы, непосредственно, и будем обновлять.
В данном случае, поля FoodCount и TrophyCount должны быть инкапсулированы в классе BagUI . Соответственно нужно установить им модификатор доступа private . Теперь, чтобы иметь возможность задать полям значения, добавляем атрибут SerializeField и прокидываем ссылки на нужные компоненты текста Unity через редактор. Таким образом, инкапсуляция не нарушена, а нужные значения полей установлены. Всё, вы прекрасны.
Стоит отметить, что есть ещё, как минимум, один способ задать значения приватных не сериализуемых полей, которым очень часто пользуются. С помошью MonoBehaviour.GetComponent и подобных ему. Например в методе Start или Awake.
При таком подходе, если мы пытаемся взять компонент у GameObject на котором исполняется текущий код, следует добавить к классу с исполняемым кодом атрибут RequireComponent, и это будет гарантировать, что при попытке получить нужный компонент — мы его получим (на самом деле не будет, но это уже совсем другая история).
Например, это может выглядеть так
Однако, если нужно получить компоненты из других GameObject, то мы не можем гарантировать их наличие во время выполнения приложения. И самым надёжным и правильным способом инъекций зависимостей является использование атрибута SerializeField и ручное прокидывание ссылок через редактор. ( SerializeField явно покажет Вам в редакторе, что у скрипта есть зависимость и её нужно назначить).
Источник