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

publicまたは[SerializeField]を付けてInspectorウィンドウに表示したものの、チームのメンバーがそのフィールドに入れるべき値を分かっていない、なんてことがあるかも。

あるいは自分だけで頑張ってリリースしたアプリのメンテで、3か月ぶりにこのフィールドを触るけど、どんな値を入れたらいいんだっけ……みたいな状況もあるかもしれません。

困ったことになる前に使っておきたいのが、ToolTipAttribute。Inspectorウィンドウに表示されるフィールド名にマウスカーソルを合わせると、ヒントメッセージをホバーで表示してくれます。

同じようにヒントを残すなら[Header]のAttributeを使う方法もありますが、こっちはInspectorウィンドウのスペースを消費しないやり方です。

環境

macOS 10.13 High Sierra

Unity2018.1.0f2

ToolTipについて

ホバーウィンドウでヒントメッセージを表示してくれるAttributeです。

Inspectorウィンドウに表示されたフィールド名にマウスカーソルを合わせると、ぽこっとメッセージが表示されます。

Rigidbodyのmassとかdragのフィールド名でもこのToolTipが表示されたりします。

自作スクリプトでは、フィールドに入れる値をちゃんと説明しておかないとチーム内でも混乱を招く場合があるので、こうした補助を入れておくといい感じです。

また、Editor拡張を配布する場合なんかもTooltipでヒントを記載しておくと親切かも。Unityの画面から離れずに使い方を確認できるとときめきます。

サンプル

使い方はいたってシンプル。Inspectorに表示するフィールドで、ヒントメッセージを表示したいものに[ToolTip(表示する文字列)]を付けるだけ。

上記のスクリプトのようにヒントメッセージを仕込んだら、任意のゲームオブジェクトにアタッチして表示してみます。

上からヒントメッセージを表示させてみます。

Hpのヒントでは、バックスラッシュのnで改行を入れてみました。ちゃんと改行コードを入れた位置で改行されていますね。デバッグ担当の方宛にメッセージを入れておくのも良いかも。

Atkでは改行を入れなかったのですが、全角25文字くらいの位置で自動的に改行されています。[Range]のAttributeとも共存できています。

まとめ

ちょっと作業量は多くなるかもしれませんが、publicまたは[SerializeField]でInspectorに表示するフィールドにはToolTipでヒントを表示すると良い感じ。

特にチーム内でフィールドの使い方を共有するのにも便利なので、なるべくなら入れておくとコミュニケーションコストが減少! ……するかも。