【Unity】Inspectorウィンドウでの表示に関わるAttributeのまとめ

Attributeって結構な種類があるけれど、ここではInspectorでの表示に関わるAttributeをまとめ。

スクリプトリファレンスで[UnityEngine] -> [Attributes]と進めば何があるかまでは分かるけど、1個1個見ていって効果を確かめるのもめんど大変なので、自分用にまとめておくことに。

Attributeは2018年7月の時点で35種類あるけれど、そのうち8つのAttributeがInspectorでの表示に関わるものです。

環境

macOS 10.13 High Sierra

Unity2018.1.0f2

Inspectorウィンドウでの表示に関わるAttribute

表にまとめると以下の通り。何をもって「表示系」と言っているかは割と主観に塗れてるけど、デフォルトのInspectorウィンドウから見え方が変わるものをチョイスしてます。

なんかこう、RPGの魔法の効果をまとめている気分になりました。

それぞれのAttributeについてはこのブログでも解説しているので、そちらもご覧あれ。

HeaderAttribute

記述した位置にヘッダーを追加するAttributeです。画像の例だと、「HPの設定項目」や「MPの設定項目」、「強さの設定項目」をHeaderAttributeで表示しています。

Inspectorウィンドウに表示する項目を整理したい時に便利です。

エクスプラボ

【Unity】HeaderAttributeを使ってフィールドを整理してみなイカ?

https://ekulabo.com/attribute-header

HeaderAttributeを使って、Inspectorウィンドウに表示されるフィールドを整理して表示できます。RPG系のゲームではテストプレイ中にパラメータをいじることも多いと思うので、Headerをうまく使って整理しておくと、操作するべきフィールドがすぐに見つかるはず。

HideInInspector

このAttributeを付けたフィールドをInspectorウィンドウに表示しないようにします。

主にpublicなフィールドに付けるAttributeで、フィールド自体は外部のスクリプトから操作できるようにしたいけど、Inspectorウィンドウから値を変更して欲しくない、なんて時に使います。

エクスプラボ

 

2 Pockets

【Unity】HideInInspectorとSerializeFieldの興味深い関係

https://ekulabo.com/hide-in-inspector

publicのフィールドやをつけたフィールドはシリアライズの対象となり、Inspectorウィンドウに表示されるようになります。今回扱うを使うと、シリアライズの対象フィールドでもInspectorウィンドウで非表示にすることができます。

MultilineAttribute

複数行のテキストエリアを表示するAttributeです。

string型のフィールド、またはジェネリックリストのタイプがstringであるフィールドに対して使えます。

エクスプラボ

 

1 User

1 Pocket

【Unity】MultilineAttributeを使ってInspectorで複数行テキストを扱う

https://ekulabo.com/multiline-attribute

Inspectorウィンドウで複数行テキストエリアを表示したい場合はのAttributeを使います。長文を書く場合には通常のテキストフィールドだと狭いため、ある程度大きい複数行テキストエリアにしておくと編集しやすいです。

RangeAttribute

入力値の範囲を設定し、スライダーによって値を入力できるようにするAttributeです。

int型、またはfloat型のフィールドで有効です。

入力値の範囲はあくまでもInspectorウィンドウでの入力に対してであり、スクリプト内でRangeの範囲外の値を設定するとそのまま入ってしまうので注意。

エクスプラボ

 

2 Pockets

【Unity】RangeAttributeの最小値・最大値をConstで指定する

https://ekulabo.com/range-const

Unityではメンバ変数(フィールド)にRangeAttributeを指定しておくと、Inspectorウィンドウでスライダーを使って値を調整できるようになります。最大値と最小値を指定するため、Inspectorでの操作で変な値が入ることも少なくなり、スライダーの移動量で大体の値を掴むこともできます。

SerializeField

このAttributeを付けたフィールドをシリアライズの対象とし、Inspectorウィンドウで表示するようにします。

publicなフィールドはデフォルトでシリアライズの対象となるので、このAttributeを使うのは主にprivateなフィールドです。

他のスクリプトから値を変えて欲しくないけど、Inspectorウィンドウでは表示させて値の調整をしたい、なんて時に使います。

ぱっと見HideInInspectorと対をなす効果のようですが、あちらはInspectorウィンドウへの表示を制御するAttribute、こちらはシリアライズの制御を行うAttributeなので似て非なるもの。

シリアライズする => Unity側でフィールドの値を保持する => そのためについでにInspectorに表示する、という考え方なので、作用する場所が異なるのです。

エクスプラボ

 

1 Pocket

【Unity】Inspectorで値を変える時、publicとSerializeFieldどっち使う?

https://ekulabo.com/public-or-serializefield

スクリプトを書く時に悩む、Inspectorに表示したいフィールドの公開方法。publicなら簡単だけど他のスクリプトからアクセスできちゃうし、でInspectorに表示するのが無難かなーなんて思いつつ、2つの方法の使い分けを記載。

エクスプラボ

 

2 Pockets

【Unity】HideInInspectorとSerializeFieldの興味深い関係

https://ekulabo.com/hide-in-inspector

publicのフィールドやをつけたフィールドはシリアライズの対象となり、Inspectorウィンドウに表示されるようになります。今回扱うを使うと、シリアライズの対象フィールドでもInspectorウィンドウで非表示にすることができます。

SpaceAttribute

記述した位置にスペースを追加するAttributeです。

HeaderAttributeと組み合わせてInspectorウィンドウに表示するフィールドを整理するのに最適です。例えばデザイナーとバトルプランナーで触る部分を分けておけば、担当者が自分の作業範囲を認識しやすくなるかもしれません。

エクスプラボ

【Unity】SpaceAttributeを使ってInspectorウィンドウを見やすく!

https://ekulabo.com/attribute-space

SpaceAttributeはInspectorウィンドウで余白を表示することができるAttributeです。関連性のあるフィールドをまとめて表示すれば、どこを触ったらいいのか分かりやすくなります。HeaderAttrubuteと組み合わせればより効果的。

TextAreaAttribute

複数行のテキストエリアを表示するAttributeです。

MultilineAttributeと似ていますが、こちらはスクロールバーが表示され、横幅も広いテキストエリアとなっています。

下の画像だと、TextArea2のテキストエリアにスクロールバーが表示されています。

エクスプラボ

【Unity】スクロールバー付きのテキストエリアならTextAreaAttribute

https://ekulabo.com/text-area-attribute

複数行テキストを扱うなら、もいいけどを使うと便利です。何よりスクロールバーを使えるのがありがたい。テキストエリアの内容確認ならスクロールバーがあった方が何かと扱いやすいです。

TooltipAttribute

フィールドの説明などのヒントメッセージを表示できるAttributeです。

UnityデフォルトのコンポーネントであるTransformやRigidbodyでも使われています。Inspectorウィンドウのスペースを使わずにヒントを表示できるので、該当のフィールドの使い方を記載しておくと非常に便利。

エクスプラボ

 

1 User

7 Pockets

【Unity】ToolTipでフィールドのヒントメッセージを表示する

https://ekulabo.com/tool-tip-attribute

Inspectorウィンドウに表示するフィールドはToolTipAttributeを使ってヒントメッセージを表示すると親切です。カーソルを合わせるだけでメッセージを表示できるので、Inspectorウィンドウ内のスペースも取らなくて便利。チーム内の意思伝達のおともにぜひ。

まとめのまとめ

このページではInspectorウィンドウへの表示に関わるAttributeの一覧をまとめました。

これでもUnityに存在するAttributeの約20%程度。Attributeの世界は広いなぁ……(遠い目)