SerializeField
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 <a>try again</a> 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.
Почему я должен использовать SerializeField?
Я только начал изучать C # и Unity, и есть одна вещь, к которой я не могу привыкнуть:
Почему и когда мне следует использовать [SerializeField] ?
Плохо ли оставлять переменные жестко запрограммированными, несмотря на использование [SerializeField] и иметь больше текстовых полей в моем интерфейсе единства?
Заранее благодарим за внимание и терпение.
2 ответа
Почему и когда мне следует использовать [SerializeField]?
Использование атрибута SerializeField заставляет Unity сериализовать любую переменную private . Это не относится к статическим переменным и свойствам в C #.
Вы используете атрибут SerializeField , когда вам нужно, чтобы ваша переменная была private , но также хотите, чтобы она отображалась в редакторе.
Например, это не будет отображаться в редакторе:
И это потому, что это переменная private , но в редакторе должна появиться указанная ниже:
Это потому, что вы применили к нему SerializeField и приказываете Unity сериализовать его и показать в редакторе.
Обратите внимание, что переменные private больше связаны с C #, чем с Unity. Есть также общедоступные переменные переменные. Пометка вашей переменной private означает, что вы не хотите, чтобы другой скрипт имел доступ к этой переменной. Также есть квалификатор public . Пометка вашей переменной public означает, что вы хотите, чтобы другие ваши скрипты имели доступ к этой переменной.
Иногда вы хотите, чтобы другие скрипты могли получить доступ к вашей переменной из другого скрипта, но вы не хотите, чтобы переменная public отображалась в редакторе. Вы можете скрыть переменную public с помощью атрибута [HideInInspector] .
Это будет отображаться в редакторе:
Это не будет отображаться в редакторе:
Плохо ли оставлять переменные жестко запрограммированными, несмотря на использование [SerializeField] и иметь больше текстовых полей в моем интерфейсе единства?
Да, в основном это плохо, особенно для новых пользователей. Это не должно быть большой проблемой для программистов на Unity и C #. Причина в том, что это плохо, потому что, когда у вас есть код ниже:
В редакторе значение по умолчанию — 5 . После сохранения скрипта эта переменная теперь обновляется в редакторе как 5. Проблема в том, что вы можете изменить это значение в редакторе на 14 . После того, как вы измените его из редактора, значение в скрипте по-прежнему будет 5 , но когда вы запустите его, Unity будет использовать значение, которое вы установили в редакторе, то есть 14 . Это может привести к тому, что у вас будет много времени на устранение неполадок, что даже не является проблемой только потому, что используется другое значение, установленное в редакторе, в то время как вы ожидаете, что будет использоваться значение по умолчанию, установленное в скрипте.
Единственный способ восстановить для переменной score значение по умолчанию 5 — это переименовать переменную в другое имя или сбросить ее из редактора. Это даже не изменится, даже если вы измените значение с 5 на 3 из скрипта. Его необходимо переименовать или сбросить в редакторе. Об этом стоит знать, но когда вы привыкнете к Unity, вам не придется об этом беспокоиться.
Атрибут [SerializeField] используется для пометки закрытых полей как сериализуемых: чтобы Unity могла сохранять и загружать эти значения (все общедоступные поля по умолчанию сериализуются), даже если они не являются общедоступными.
SerializeField
Благодарим вас за то, что вы помогаете нам улучшить качество документации по Unity. Однако, мы не можем принять любой перевод. Мы проверяем каждый предложенный вами вариант перевода и принимаем его только если он соответствует оригиналу.
Ошибка внесения изменений
По определённым причинам предложенный вами перевод не может быть принят. Пожалуйста <a>попробуйте снова</a> через пару минут. И выражаем вам свою благодарность за то, что вы уделяете время, чтобы улучшить документацию по 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.