[Unity] Property 인스펙터에 표시하기

유니티에서 변수를 인스펙터에 표시하기 위해 [SerializeField], [Serializable] 등으로 직렬화를 진행한다.

대부분의 변수는 public으로 선언할 경우 자동으로 직렬화 되고, 커스텀 클래스의 경우 [Serializable] 붙여주면 된다.

 

그런데 인터페이스 등을 사용해서 프로퍼티로 관리하는 경우, 인스펙터에 노출시키려면 어떻게 해야할까?

 

---

 

프로퍼티는 단순히 [SerializeField]로 하면 인스펙터에 표시되지 않는다.

이때는 [field: SerializeField]를 사용해 인스펙터에 표시한다.

주의할 점은 자동 구현된 프로퍼티에만 사용 가능하다.

get, set 액세서를 직접 구현하는 경우에는 인스펙터 노출이 안된다.

public class A : MonoBehaviour
{
	[field: SerializedField] public int Health {get; set;} // 자동 구현된 프로퍼티 노출
	// private int _health;
	// [field: SerializedField] public int Health {get { _health}; set;} // 수동 구현, 노출 안됨!
}

 

보통의 변수는 [SerializeField]로 표시하면 저장된 .prefab에서 다음과 같이 작성되어있다.

%YAML 1.1
%TAG !u! tag:unity3d.com,2011:
...
MonoBehaviour:
...
  helath: 30
...

 

그러나 프로퍼티에 [field: SerializeField]를 사용하면 .prefab에 BackingField라는 이름으로 저장된다.

%YAML 1.1
%TAG !u! tag:unity3d.com,2011:
...
MonoBehaviour:
...
  <health>k__BackingField: 30
...

 

이를 이해하기 위해선 먼저 프로퍼티 개념을 알아야한다.

 

'프로퍼티'는 마치 공용 변수처럼 클래스 내에 존재하지만, 실제로는 '액세서' 라는 특수 메소드로 기능한다.

프로퍼티에는 private 필드에 접근하는 get과 set 메소드가 있으며, 이를 'Backing Field'라고 한다.

https://unity.com/how-to/formatting-best-practices-c-scripting-unity#properties

 

즉, 내부적으로 BackingField라는 private 필드가 존재하며

유니티에서 이를 직렬화하면 BackingField라는 이름으로 저장되는 것이다.

 

위에서 사용한 [ield: SerializeField]는 내부적으로 BackingField를 직렬화 하는 어트리뷰트다.

[SerializeField]로 대체할 수 있으며, 아래처럼 명시적으로 Backing Field를 클래스 안에 만들어주면 된다.

 

[SerializeField]
private float _helath; // backing field
public float Helath { get => _helath; set => _helath = value; } //property

 

---

 

그러나 매 변수마다 Backing Field를 만들기 번거롭다.

인터페이스를 사용할 때, 데이터 캡슐화를 위한 프로퍼티는 [field: SerializeField]를 쓰는게 유용할 것 같다.

 

참고사이트

https://discussions.unity.com/t/what-does-field-serializedfield-actually-do/929813/3

 

https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/classes-and-structs/using-properties

Using Properties - C#

 

https://unity.com/kr/how-to/formatting-best-practices-c-scripting-unity