この記事はUnity Advent Calendar 2022（その2） 20日目の記事です。
昨日は@copoさんの「【Unity】シェーダで穴をあけるマッピング」でした！
こんなこともできるんだなぁと非常に楽しく拝見しました！Unityでも深淵を覗くことができそうですね！
はじめに
業務中、なぜかインスペクターに表示されないフィールドがあり、publicかSerializeFieldをつけておけばだいたいオッケー！と思う気持ちを改めて、どういったものが表示されるのか、されないのかまとめてみました。
また、今回自分がハマったポイントと合わせてご紹介しようと思います。
環境
| Unity | 2021.3.13f1 |
|---|
そもそもどういったものがインスペクターに表示できるのか
インスペクターに表示するにはシリアル化の対象とする必要があります。
シリアル化とは、保存して後で再構成できる形式に変換する自動処理です。
これによってプレハブとして保存したり、インスペクターに値を設定するとUnity再起動しても同じ値が表示されていたりするわけです。
以下条件を全て満たすことで、シリアル化の対象となります。
- publicであるか、SerializeField属性を持っていること。
- 静的(static)でないこと。
- constではないこと。
- 読み取り専用（readonly）でないこと。
- シリアル化可能なフィールド型であること。
5. シリアル化可能なフィールド型であること。
こちらについては、以下いずれかの型である必要もあります。
- プリミティブなデータ型であること。
- int、float、double、bool、stringなど
- Enum 型 (32 バイト以下) であること。
- 固定サイズバッファであること。
- Unity の組み込み型であること。
- Vector2、Vector3、Rect、Matrix4x4、Color、AnimationCurveなど
- Serializable 属性をもつカスタム構造体であること。
- UnityEngine.Object から派生するオブジェクトへの参照であること。
- Serializable 属性を持つカスタムクラスであること。
- 自作したクラスはカスタムクラスと呼ばれSerializable属性を付与することでシリアル化することができます。 （カスタムクラスのシリアライズ）
- 上記のフィールド型の配列であること。
- 一次元配列のみ、後述の多次元配列はできない。
- 上記のフィールド型の List であること。
シリアル化の条件を満たしている（はず）なのに表示されない！
よくある？表示されないパターンを挙げてみます。
シリアル化できない型を指定している
先程の、シリアル化可能なフィールド型であること。の条件が細かく別れているので、うっかりできると思っているものができないかもしれません。
例えば以下のリストはそのままでは表示することができません。
- 多次元配列
例）public int[,] multiArray; - ジャグ配列（配列の配列）
例）public int[][] jaggedArray - ネストしたコンテナ型
例）public List<List<int>> nestedList; - 辞書
例）public Dictionary<int, string> dictionary;
ただ、こちらは一応回避方法もあります。
回避方法1.クラスまたは構造体でネストされた型をラップ
カスタムクラス内に値を持ち、そのクラスを更にリストとして持つと表示することができます。
[Serializable]
public class Data
{
public List<int> ids;
}
public List<Data> datas;
public List<List<int>> datas2
回避方法2.シリアル化コールバック（ISerializationCallbackReceiver）
少々長くなりそうなため割愛しますが、シリアライズ、デシリアライズ時に発火されるコールバックで例えばstringなどのシリアル化可能な値から任意の値にパースして扱うという方法になります。
HideInInspectorまたはNonSerializableの属性が設定されている
こちらはあえてInspectorに表示されないようにする設定になります。
やっていることは、HideInInspectorはインスペクターに表示されないようにする、NonSerializableはシリアル化されないようにする、と意味は違いますが結果的にはどちらもインスペクター上に表示されないようになります。
コンパイルエラーが発生している
こちらは実行もできないため気づきやすいかもしれませんね。
コンパイルエラーが発生していると、新たに追加や変更をした箇所の更新が行われません。
Consoleの表示を確認してみましょう。
CustomEditor属性でインスペクターで表示する内容の変更が行われている
Unityでは、CustomEditor属性を付与することでエディター表示を変更し、独自のインスペクター表示を構成することができます。
ボタンをつけてメソッドを実行したり、表示をリッチにしたりできるため便利ではあるのですが、ちょっとした罠もあります。
罠について
今回私がハマったポイントについて。
以下は、Unityのカスタムエディターのドキュメントに乗っているサンプルの一部です。
using UnityEngine;
public class LookAtPoint : MonoBehaviour
{
public Vector3 lookAtPoint = Vector3.zero;
void Update()
{
transform.LookAt(lookAtPoint);
}
}
using UnityEngine;
using UnityEditor;
[CustomEditor(typeof(LookAtPoint))]
[CanEditMultipleObjects]
public class LookAtPointEditor : Editor
{
SerializedProperty lookAtPoint;
void OnEnable()
{
lookAtPoint = serializedObject.FindProperty("lookAtPoint");
}
public override void OnInspectorGUI()
{
serializedObject.Update();
EditorGUILayout.PropertyField(lookAtPoint);
serializedObject.ApplyModifiedProperties();
}
}
GameObjectにLookAtPointEditorをアタッチすることで、このように表示されるのですが。
例えばポイントの名前を追加しようと思い、先程挙げたシリアル化の条件を満たしたフィールドを追加します。
// 〜略〜
public Vector3 lookAtPoint = Vector3.zero;
public string pointName; // 追加
void Update()
{
// 〜略〜
もちろん表示されませんね。
(一応先ほどと違う画像です。)
LookAtPointEditor側で表示したいものを追加してあげなければなりません。
複数人で作業している時はもちろん、数ヶ月後の自分は他人なのでカスタムエディタを利用していることを忘れているかもしれません。
クラスのコメントに明記する、カスタムエディタだとわかりやすいデザインにする、など気づきやすい工夫が必要かもしれません。
終わりに
知っていないとなかなか気づかない問題もあるかと思います。
そのため、予めこういう場合に表示されるんだなということを知っておき、順番に原因をあたっていくことが大切だなと改めて思いました。
もしこの記事で困っている方が解決して年を越せますと幸いです。
明日は、 @hoktistさんの「Unity + Arduinoできっちりオンオフのできる双方向通信をしよう」です！
参考