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

SerializedProperty Extensions

Запись значений и доступ к полям C# через SerializedProperty.

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

До — Unity APIПосле — FastTools
serializedObject.Update();
manaCost.intValue = 42;
serializedObject
.ApplyModifiedProperties();
manaCost
.Update()
.SetIntAndApply(42);

Запись значений​

ВызовЧто делает
SetInt(42)Записывает значение
SetIntAndApply(42)Записывает и применяет изменения
SetIntAndApplyWithoutUndo(42)Записывает и применяет изменения без Undo

Перегрузки SetValue выбирают сеттер по типу аргумента: SetValue(42) вызывает SetInt. Тип аргумента должен совпадать с типом поля. Целые типы меньше int, а также char, тоже вызывают SetInt. Полный список сеттеров — в справочнике API.

Перечисления, массивы и ссылки​

UnityFastTools
intValue = (int)Rarity.RareSetEnum(Rarity.Rare)
enumValueIndex = 1SetEnumIndex(1)
enumValueFlag = flagsSetEnumFlag(flags)
arraySize = 5SetArraySize(5)
arraySize++AddArraySize()
arraySize--RemoveArraySize()
managedReferenceValue = valueSetManagedReference(value)
objectReferenceValue = valueSetObjectReference(value)
boxedValue = valueSetBoxed(value)
exposedReferenceValue = valueSetExposedReference(value)
  • У SetEnumIndex и SetEnumFlag нет формы SetValue: вызывайте их по имени.
  • SetValue(1) для поля-перечисления вызывает SetInt: записывается значение 1, а не индекс.
  • Значение перечисления записывают SetEnum и SetValue(Rarity.Rare).
внимание

С контекстом IExposedPropertyTable, например PlayableDirector, SetExposedReference() сразу кладёт ссылку в таблицу, но новое имя остаётся неприменённым. Вызовите после него ApplyModifiedProperties(): иначе очередное обновление или перезагрузка домена сбросят имя, и запись в таблице останется без владельца.

Update() и Apply…()​

Методы вызываются на свойстве и, как сеттеры, возвращают его для цепочек вызовов.

UnityFastTools
serializedObject.Update()Update()
serializedObject.UpdateIfRequiredOrScript()UpdateIfRequiredOrScript()
serializedObject.ApplyModifiedProperties()ApplyModifiedProperties()
serializedObject.ApplyModifiedPropertiesWithoutUndo()ApplyModifiedPropertiesWithoutUndo()

Доступ к полю C#​

Методы возвращают тип поля, его FieldInfo и объект-владелец.

public class AbilityBook : MonoBehaviour
{
[SerializeField]
private List<Ability> _abilities = new() { new Ability() };

[SerializeReference]
private IAbilityEffect _effect = new BurnEffect();
}

[Serializable]
public class Ability { public string Name = "Fireball"; }

[Serializable]
public class BurnEffect : IAbilityEffect { public float Damage = 5f; }
Поле / элементGetPropertyType()GetFieldInfo()GetDeclaringInstance()
_abilitiesList<Ability>AbilityBook._abilitiesэкземпляр AbilityBook
_abilities[0]AbilityAbilityBook._abilitiesэкземпляр AbilityBook
_abilities[0].NamestringAbility.NameAbility с индексом 0
_effectIAbilityEffectAbilityBook._effectэкземпляр AbilityBook
_effect.DamagefloatBurnEffect.Damageэкземпляр BurnEffect
  • если поле не найдено, GetPropertyType() и GetFieldInfo() возвращают null, а GetDeclaringInstance() — только когда не найден объект-владелец;
  • методы читают только первый целевой объект и только применённые значения.
внимание

Если владелец поля — структура, GetDeclaringInstance() возвращает её boxed-копию. Изменения такой копии не попадают в оригинал; записывайте значения через SerializedProperty.

Имя поля и проверки для отрисовки​

Поле / элементGetMemberName()IsArrayElement()HasFoldout()
_abilities[0]"_abilities"truetrue
_abilities[0].Name"Name"falsefalse
_effect"_effect"falsefalse
примечание

HasFoldout() проверяет обычные составные поля с видимыми вложенными полями. Не учитывает [SerializeReference] и пользовательские PropertyDrawer.

Persistent()​

Persistent() возвращает копию свойства на собственном SerializedObject: её можно использовать позже, например в EditorApplication.delayCall.

  • копия принадлежит вызывающему коду: освободите её вместе с её serializedObject;
  • неприменённые записи исходного свойства в копию не попадают;
  • если свойства на объектах нет, метод возвращает null.
var independent = manaCost.Persistent();
if (independent == null) return;

EditorApplication.delayCall += () =>
{
using (independent.serializedObject)
using (independent)
independent.Update().SetIntAndApply(42);
};

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

В EditorTools кнопка Reset to defaults записывает два свойства через SetFloat и SetIntAndApply.

Кнопка Reset to defaults возвращает стоимости и перезарядке значения по умолчанию, а Undo — прежние значения.Кнопка Reset to defaults возвращает стоимости и перезарядке значения по умолчанию, а Undo — прежние значения.