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

【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(表示する文字列)]を付けるだけ。

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

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

MaxHpのヒント
MaxHpのヒント

 

Hpのヒント
Hpのヒント

 

Atkのヒント
Atkのヒント

 

Defのヒントでち
Defのヒントでち

 

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

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

まとめ

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

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

アプリ公開までの攻略チャートを作りました!

CTA-IMAGE

「スマホ向けのアプリを作ってみたいけど、何から手を付けていいか分からない!」


そんなお悩みをお持ちの方向けに、todoがアプリをリリースした経験から手順や考慮すべき点をまとめたe-bookを作成しました。ゲーム作りはそれ自体がゲームのように楽しいプロセスなので、「攻略チャート」と名付けています。


アプリをリリースする観点から書いているので各アプリストア向けの作業が入っていますが、企画、設計、開発、テスト部分については他のプラットフォームでも使える知識が満載です。


無料で入手できるのでぜひお早めにゲットして、開発をブーストさせてください!