TooltipAttribute
Specify a tooltip for a field in the Inspector window.
Read time 4 minutesLast updated 4 days ago
Definition
- Type: Class
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
- Inherits from: PropertyAttribute
[AttributeUsage(AttributeTargets.All, Inherited = true, AllowMultiple = false)]public class TooltipAttribute : PropertyAttribute
Remarks
Tooltip hovering over the class it was added to.
In the following script a is added. This provides information to the user about the range of values for the variable. The suggested range is provided in the TooltipAttribute string.
TooltiphealthNote: Unity will only use Tooltips from Fields when displaying them in the Editor. You can add Tooltips to other areas, such as classes, structs, and properties to work with user created editor extensions, but Unity won't display them in the Editor.
Examples
using UnityEngine;public class Example : MonoBehaviour{ [Tooltip("Health value between 0 and 100.")] int health = 0;}
Fields
Value | Description |
|---|---|
| tooltip | The tooltip text. |
Constructors
Constructor | Description |
|---|---|
| TooltipAttribute(System.String) | Specify a tooltip for a field. |