(유니티3D)커스텀 에디터(인스펙터 창 변경)

글 작성에 앞서 저도 다른 분들의 글을 참고하며 배웠습니다

그렇기에 코드에 그 분들의 흔적이 다소 남아있으며 이 글로는 부족하다면 추가로 보는 것도 좋을 것 같습니다.

https://486boy.blogspot.kr/2014/05/unity.html

http://mobilism.tistory.com/entry/Unity3D-%EC%97%90%EB%94%94%ED%84%B0-%EC%BB%A4%EC%8A%A4%ED%84%B0%EB%A7%88%EC%9D%B4%EC%A6%88-1

유니티는 Inspector 창을 통해 굉장히 쉽게 특정 변수에 접근이 가능하고 이를 통해 개발자는 실시간으로 특정 변수의 값을 확인하고 변경할 수 있어 눈으로 확인하면서 변화를 줄 수 있습니다.

물론 굳이 에디터 커스터마이징을 거치지 않고도 자체적으로 인스펙터 속성을 통해 배치를 하는 것도 가능합니다.

대부분의 경우는 이 속성만으로도 충분히 깔끔하게 만들 수 있습니다.

하지만 하나의 스크립트에 많은 기능을 내포하고 있는 경우 Bool이나 Enum으로 일종의 모드를 바꾸는 방식을 취하는 경우가 많은데 이 때 선택한 모드에 따라 필요한 부분과 필요 없어지는 부분이 생깁니다.

어차피 필요 없어진 부분은 어떤 값을 넣어도 영향을 주지 않겠지만 기능이 많을 수록 변수의 양도 많을테니 사용 유무의 관계없이 항상 전부 보여준다면 Inspector 창은 굉장히 지저분해 보일 것입니다.

그 때 필요한 것이 에디터 커스터마이징입니다.

이를 이용하면 자체 지원하는 속성 이외에도 더 많은 부분을 직접 건드릴 수 있습니다.

이전 글에 썼던 이미지인데 이처럼 공통적으로 필요한 부분은 놔두고 모드에 따라 특정 입력 필드만 생기게 만들 수도 있습니다.

여기서는 Bool의 값에 따라 바뀌게 했지만 Enum을 활용하여 콤보박스의 형태로 만들 수도 있습니다.

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEditor;
 
[CustomEditor(typeof(MovingBoardRepair))]//적용시킬 스크립트의 이름을 적는다.
 
public class SimpleEditorInspector : Editor
{
    MovingBoardRepair _editor;
 
    void OnEnable()
    {
        // target은 위의 CustomEditor() 애트리뷰트에서 설정해 준 타입의 객체에 대한 레퍼런스
        // object형이므로 실제 사용할 타입으로 캐스팅 해 준다.
        _editor = target as MovingBoardRepair;
    }
 
    public override void OnInspectorGUI()  //Editor상속, 커스텀에디터 구현 함수 재 정의.  
    {
        _editor.debugLine = EditorGUILayout.Toggle(new GUIContent("Debug Line", "씬 뷰에 경로를 붉은 선으로 보여줍니다."), _editor.debugLine);
        //.debugLine은 MovingBoardRepair 스크립트에 public으로 존재하는 변수이다.
        //bool형은 체크박스의 형태로 인스펙터 창에 나타나는데 이와 대응하는게 토글이다.
        //new GUIContent를 사용함으로써 [Tootip]을 사용할 수 있다. 그냥 "Debug Line", _editor.debugLine의 형태로 사용하면 툴팁이 빠진 그대로의 형태만 쓸 수 있다.
 
        EditorGUILayout.Space();    //구분을 위한 공백 삽입
        UseProperty("relativeMovePoint");   //아래 함수로 만들어 둔 부분 참조
        EditorGUILayout.Space();
        _editor.awakeStart = EditorGUILayout.Toggle(new GUIContent("Awake Start", "게임 시작과 동시에 움직이게 합니다. false의 경우 캐릭터가 올라타면 움직입니다."), _editor.awakeStart);
        if (_editor.awakeStart) //조건에 따라 표시하는 변수가 다르다.
        {
            _editor.awakeWaitTime = EditorGUILayout.FloatField(new GUIContent("Awake Wait Time", "게임 시작 직후 처음 움직이기까지 대기 시간"), _editor.awakeWaitTime);
            //float의 경우 FloatField를 쓴다. 인자는 bool 위치에 float을 쓰는 것 외엔 동일
        }
        else
        {   //true일 경우 위 변수만이 필요하고 flase일 경우 아래 변수만이 쓰이므로 필요한 것만 보이게 한다.
            _editor.destroyWaitTime = EditorGUILayout.FloatField(new GUIContent("Destroy Wait Time", "최종 목적지에 도달하고 삭제되기까지의 대기 시간"), _editor.destroyWaitTime);
            _editor.respawnTime = EditorGUILayout.FloatField(new GUIContent("Respawn Time", "재생성 시간"), _editor.respawnTime);
        }
        EditorGUILayout.Space();
        //그외 공통적으로 적용되는 변수들
        _editor.speed = EditorGUILayout.FloatField(new GUIContent("Speed", "이동 속도"), _editor.speed);
        _editor.waitTime = EditorGUILayout.FloatField(new GUIContent("Wait Time", "경유지 대기 시간"), _editor.waitTime);
        _editor.jumpInertia = EditorGUILayout.Toggle(new GUIContent("Jump Inertia", "점프 관성 포함"), _editor.jumpInertia);
 
        if (GUI.changed)    //변경이 있을 시 적용된다. 이 코드가 없으면 인스펙터 창에서 변화는 있지만 적용은 되지 않는다.
            EditorUtility.SetDirty(target);
    }
 
    void UseProperty(string propertyName)   //해당 변수를 원래의 pubilc 형태로 사용
    {   //배열의 경우 이곳으로 불러오는 기능을 자체적으로 지원하지 않는다. 여러 방법이 있겠지만 이 방법을 쓰면 원래 쓰던 그대로를 가져올 수 있다.
        SerializedProperty tps = serializedObject.FindProperty(propertyName);   //변수명을 입력해서 찾는다.
        EditorGUI.BeginChangeCheck();   //Begin과 End로 값이 바뀌는 것을 검사한다.
        EditorGUILayout.PropertyField(tps, true);   //변수에 맞는 필드 생성. 인자의 true부분은 includeChildren로써 자식에 해당하는 부분까지 모두 가져온다는 뜻이다.
                                                    //만약 여기서 false를 하면 변수명 자체는 인스펙터 창에 뜨지만 배열항목이 아예 뜨지 않아 이름뿐인 항목이 된다.
        if (EditorGUI.EndChangeCheck()) //여기까지 검사해서 필드에 변화가 있으면
            serializedObject.ApplyModifiedProperties(); //원래 변수에 적용시킨다.
 
        //툴팁의 경우 원래 스크립트의 있는 것을 가져온다.
    }
}
 

코드는 마찬가지로 이전 글에 썼던 것을 이용하겠습니다.

주석으로 상세하게 달아두긴 했는데 기존 스크립트들과는 다른 부분에 대해서만 더 짚고 가겠습니다.

가장 먼저 Editor 클래스는 Editor 폴더에 들어있어야 합니다. 

꼭 Asset/Editor 의 경로일 필요는 없습니다. 저같은 경우 Asset/Script/Editor 의 경로에 넣었는데 잘 작동됩니다. 

또한 Editor 폴더에 담긴 스크립트는 최종빌드에 포함되지 않는다고 하니 빌드본의 사양에는 영향을 주지 않는거 같습니다.

그리고 using UnityEditor; 를 해주셔야 에디터를 사용할 수 있습니다.

클래스 상속은 MonoBehaviour이 아닌 Editor로 해주셔야 합니다.

하나 특이한 점은 클래스 이름과 실제 파일명이 같아야 하는 기존 스크립트와 다르게 파일명이 달라도 정상 작동합니다.

위 코드를 보면 클래스명이 SimpleEditorInspector으로 되어있지만 파일명은 EditorInspector으로 되어있습니다. 하지만 아무런 문제가 없습니다.

기본 형태는 EditorGUILayout에 다 마련되어 있기 때문에 그대로 사용하면 됩니다. 대부분 이름도 굉장히 직관적입니다.

현재 사용한 형태는 툴팁을 위해 GUIContent를 사용하였는데 원래의 형태와 똑같이 쓰시려면

_editor.debugLine = EditorGUILayout.Toggle("Debug Line", _editor.debugLine);

이런식으로 사용하시면 됩니다. 저 "Debug Line" 부분엔 한글을 써도 됩니다.

단, 일반 변수처럼 알아서 맨 앞 글자를 대문자로 만들어주고 다음 대문자를 만나면 띄워주는 기능은 없으니 정확하게 입력해야 합니다.

조건부 형태변경에 대해서는 if문을 활용거나 switch를 사용해도 됩니다.

위 코드에서 UseProperty 함수는 내용은 유니티 커뮤니티에서 가져왔습니다.

거의 모든 형태를 지원하지만 EditorGUILayout가 배열은 지원해주지 않아 검색했더니 원본을 그대로 가져오는 방법을 알려주더군요.

원본은 함수 내에 있는 5줄입니다만 추후 활용하기 편하도록 함수로 만들었습니다.

최종적으로 EditorUtility.SetDirty(target); 코드가 있어야 사용자의 변경 사항이 실제로 적용됩니다. 이 코드가 없으면 인스펙터 창의 값들은 바뀌는데 실제로 스크립트에 적용되진 않은 모습을 보실 수 있습니다.

사용하기 위해선 하나의 스크립트를 더 만들 필요가 있어서 다소 번거롭지만 하나 제대로 만들어두면 해당 스크립트 활용이 훨씬 편해지니 알아두면 좋을 거 같습니다.