★ 8. Unity Editor 확장 입문 - [2] 표준에서 사용할 수 있는 에디터 확장 기능

[2] 표준에서 사용할 수 있는 에디터 확장 기능

2.1 인스펙터 창의 외관 변경

(1) Range

[ 좌측 : Range 사용 X, 우측 : Range 사용 O ]

using UnityEngine;
using System.Collections;
 
public class NewBehaviourScript : MonoBehaviour
{
    [Range(1, 10)]
    public int num1;
 
    [Range(1, 10)]
    public float num2;
 
    [Range(1, 10)]
    public long num3;
 
    [Range(1, 10)]
    public double num4;
}

(2) Multiline / TextArea

기본적으로 1줄의 TextField이지만 여러 줄의 TextArea로 변경할 수 있습니다.

Multiline도 TextArea랑 별 차이가 없는데, Multiline은 폭에 맞춰 자동적으로 줄바꿈되지 않고

스크롤 바를 표시하지 않습니다. 특별한 이유가 없다면 TextArea를 사용하는 것을 추천합니다.

using UnityEngine;
using System.Collections;
 
public class NewBehaviourScript : MonoBehaviour
{
    public string defaultString;
 
    [Multiline(5)]
    public string multiline;
 
    [TextArea(3,5)]
    public string textArea;
}

2.2 인스펙터에서 다루는 기능을 추가

(1) ContextMenuItem

인스펙터에 표시되어 있는 변수에 콘텍스트 메뉴를 추가합니다. 다른 변수들도 일제히 수치를 변경하지 않으면 안되거나, 순서가 필요한 요소를 자동화하는 용도로 사용하면 좋을 것 같습니다.

컴포넌트 단위로 수치를 리셋시키는 Reset 기능은 있지만 각 변수에 대한 리셋 기능은 없으므로 이 것으로 추가하면 됩니다.

using UnityEngine;
using System.Collections;
 
public class NewBehaviourScript : MonoBehaviour
{
    [ContextMenuItem("Random", "RandomNumber")]
    [ContextMenuItem("Reset", "ResetNumber")]
    public int number;
 
    void RandomNumber()
    {
        number = Random.Range(0, 100);
    }
 
    void ResetNumber()
    {
        number = 0;
    }
}

(2) ColorUsage

색의 변경을 위한 컬러 픽커를 사용합니다.

알파 값 사용/미사용, HDR용 등으로 설정합니다.

using UnityEngine;
using System.Collections;
 
public class NewBehaviourScript : MonoBehaviour
{
    public Color color1;
 
    [ColorUsage(false)]
    public Color color2;
 
    [ColorUsage(true, true, 0, 8, 0.125f, 3)]
    public Color color3;
}

2.3 인스펙터의 외관 정리

프로퍼티에 직접 작용하지는 않지만, 외관 정리용으로 사용하는 것이 있습니다.

(1) Header

using UnityEngine;
using System;
 
public class NewBehaviourScript : MonoBehaviour
{
    [Header("Player Settings")]
    public Player player;
 
    [Serializable]
    public class Player
    {
        public string name;
 
        [Range(1, 100)]
        public int hp;
    }
 
    [Header("Game Settings")]
    public Color background;
}

(2) Space

말 그대로 공백입니다. 줄을 띄울 때 사용합니다.

using UnityEngine;
 
public class NewBehaviourScript : MonoBehaviour
{
    [Space(16)]
    public string str1;
 
    [Space(48)]
    public string str2;
}

(3) Tooltip

프로퍼티에 대한 설명을 인스펙터상에서 확인하게 만들고 싶을 때 사용합니다.

using UnityEngine;
 
public class NewBehaviourScript : MonoBehaviour
{
    [Tooltip("툴 팁 입 니 다.")]
    public long tooltip;
}

(4) HideInInspector

본래 public인 변수는 인스턴스에 표시되지만 HideInInspector를 사용하면 표시되지 않습니다.

using UnityEngine;
 
public class NewBehaviourScript : MonoBehaviour
{
    public string str111;
 
    [HideInInspector]
    public string str222;
 
    public string str333;
}

2.4 인스펙터를 더 편리하게

(1) RequireComponent

[특정 컴포넌트가 최소 1개는 Attach되어 있어야 한다]고 하는 제약을 거는 속성입니다.

Animator와 관련된 스크립트를 작성할 때, Animator 컴포넌트가 붙어 있어야 한다고 제약을 걸 수 있습니다. RequireComponent가 사용된 스크립트를 Attach하면 자동으로 RequireComponent로 지정한 컴포넌트도 Attach되게 하고 이미 Attach가 되어 있으면 아무것도 하지 않습니다. 그리고 지정된 컴포넌트를 삭제하려면 하지 못한다고 표시합니다.

using UnityEngine;
 
[RequireComponent(typeof(Animator))]
public class NewBehaviourScript : MonoBehaviour
{
    Animator animator;
 
    void Awake()
    {
        animator = GetComponent<Animator>();
    }
}

(2) DisallowMultipleComponent

하나의 게임 오브젝트에 같은 컴포넌트를 여러개 Attach 하는 것을 금지하는 속성입니다.

2개 이상 같은 컴포넌트를 넣고 게임을 실행하면 못한다고 표시하며 이 속성이 설정된 클래스를 상속한 클래스에도 이 속성이 똑같이 적용됩니다.

using UnityEngine;
 
public class NewBehaviourScript : Base
{
    
}

using UnityEngine;
 
[DisallowMultipleComponent]
public class Base : MonoBehaviour
{
    
}

(3) FormerlySerializedAs

변수명을 변경했을 때에 새로운 변수명에 데이터를 이동시키기 위한 속성입니다. 인스펙터에 표시되듯이, Serialized된 데이터는 변수명을 경로로써 보존합니다. 이런 상태에서 변수명을 바꾸면 변수의 데이터는 초기화됩니다. 그래서 이런 문제를 회피하기 위한 속성입니다.

(using UnityEngine.Serialization; 을 추가해야합니다.)

using UnityEngine;
using UnityEngine.Serialization;
 
public class NewBehaviourScript : MonoBehaviour
{
    [SerializeField]
    [FormerlySerializedAs("hoge")]
    string fuga;
}

변수명의 변경과 FormerlySerializedAs 속성의 추가, oldName의 지정은 동시에 이루어져야합니다. 스크립트의 컴파일에 의해 필요 없는 데이터는 파괴되어버리고 변수명을 변경하고 한번 컴파일, 그리고나서 속성 추가하고 oldName 지정해봐야 데이터는 이미 날아가고 없다는 말입니다.

(4) AddComponentMenu

Component 메뉴에 메뉴 항목을 추가할 수 있습니다.

스크립트는 모두 Component/Scripts 메뉴의 안에 정리되어 있으며 범용적인 스크립트 컴포넌트 군을 작성할 때, 하나의 카테고리에 정리하고 싶을 때 사용합니다. AddComponentMenu를 사용한 스크립트는 다른 장소에 메뉴가 작성되므로 Component/Scripts 메뉴 안에서 소거됩니다.

using UnityEngine;
 
[AddComponentMenu("MyUI/Tween color")]
public class NewBehaviourScript : MonoBehaviour
{
 
}

2.5 게임 개발을 편하게

(1) ExecuteInEditMode

게임이 실행 중이 아니더라도 MonoBehaviour를 상속한 컴포넌트의 주요 함수가 호출되는 효과입니다.

호출되는 타이밍은 게임 오브젝트가 갱신되는 때. 씬 Asset을 더블 클릭해서 씬을 로드할 때에는 Awake와 Start 함수가, 인스펙터 등에서 컴포넌트의 변수 등을 변경할 때 Update가 호출됩니다.

또한, OnGUI에서 설치된 GUI가 에디터의 GUI 렌더링 사이클을 돌면서 표시되는 방식입니다.

using UnityEngine;
 
[ExecuteInEditMode]
public class NewBehaviourScript : MonoBehaviour
{
    [Range(0, 10)]
    public int number;
 
    void Awake()
    {
        Debug.Log("Awake");
    }
 
    void Start()
    {
        Debug.Log("Start");
    }
 
    void Update()
    {
        Debug.Log("Update");
    }
}

(2) ContextMenu

컴포넌트의 컨텍스트 메뉴에서 함수를 실행합니다.

ContextMenuItem과 이름과 기능이 비슷하지만 추가하는 컨텍스트 메뉴의 장소가 다릅니다.

using UnityEngine;
 
public class NewBehaviourScript : MonoBehaviour
{
    [Range(0, 10)]
    public int number;
 
    [ContextMenu ("RandomNumber")]
    void RandomNumber()
    {
        number = Random.Range(0, 100);
    }
 
    [ContextMenu ("ResetNumber")]
    void ResetNumber()
    {
        number = 0;
    }
}

(3) SelectionBase

씬 뷰에서 오브젝트를 선택했을 때 선택된 게임 오브젝트를 지정하거나 게임 오브젝트의 선택 순서를 결정할 때 사용합니다. 보통 씬 뷰에서 오브젝트를 선택할 때에는 루트 게임 오브젝트가 선택됩니다.

원래 Cube를 클릭하면 Cube만 선택되는데, 자식 오브젝트에 SelectionBase를 붙이게 되면 Cube를 클릭했을 때 자식 오브젝트부터 먼저 선택되는 효과

using UnityEngine;
 
[SelectionBase]
public class NewBehaviourScript : MonoBehaviour
{
    
}

저는 5.3.5f1 버전을 사용하는데 SelectionBase는 잘 안되는 것 같네요.. 이유는 잘 모르겠습니다.

Unity Editor 확장에 사용될 폴더에 대해서 알아보았습니다.

다음 강좌에서는 표준 에디터 확장 기능에 대해서 알아보겠습니다.

- 출처 -

원본 - http://anchan828.github.io/editor-manual/web/part2-standardextension.html

번역 - http://hammerimpact.blog.me/220770056749