【Unity】【Odin - Inspector and Serializer】変数やプロパティにカーソルを重ねた時にヒントを表示する「PropertyTooltip」属性

目次

「PropertyTooltip」属性

「PropertyTooltip」属性を使用すると
Inspector で変数やプロパティにカーソルを重ねた時に
ヒントを表示することができます

using Sirenix.OdinInspector;
using UnityEngine;

public class Example : MonoBehaviour
{
    // Unity
    [Tooltip( "ピチュー" )] public string text1;
    
    // Odin
    [PropertyTooltip( "ピカチュウ" )] public string text2;
    
    [PropertyTooltip( "$tooltip" )] public string tooltip;

    [ShowInInspector, PropertyTooltip( "ライチュウ" )] public string Text { get; set; }
}

使い方

下記のように記述するだけで使用できます

[PropertyTooltip( "ピカチュウ" )] public string text2;

Unity にも同様の機能を持つ「Tooltip」属性が存在します

[Tooltip( "ピチュー" )] public string text1;

Unity の「Tooltip」属性と
Odin の「PropertyTooltip」属性の違いとしては

Odin の「PropertyTooltip」属性は、
Odin の属性と併用したり、
表示する文言に変数を指定して
動的に文言を変更したりすることが可能です

例えば下記のような記述で、ヒントに表示する文言に変数を割り当てることが可能です

[PropertyTooltip( "$tooltip" )] public string tooltip;

ShowInInspector 属性と併用して
プロパティにカーソルを重ねた時にもヒントを出すことができます

[ShowInInspector, PropertyTooltip( "ライチュウ" )] public string Text { get; set; }

参考サイト様

Odin Inspector and Serializer | Improve your workflow in Unity