SerializedProperty is empty with [Tooltip] attribute

Maybe Im missing something here, but Im having problems regarding tooltips:

I have a class with several properties, which each have a [Tooltip("")] attribute assigned to them. However, when I get the SerializedProperty's .tooltip member, it is empty. Is this a bug or am I doing something wrong? Running Unity 4.6.1f1 here

here is my code:

Code (CSharp):

1. private void DrawPropertyField(Rect position, SerializedProperty property, GUIContent label)
2. {
3.    GUIContent label = new GUIContent(property.name, property.tooltip);
4.    Rect propertyRect = position;
5.    propertyRect.width -= labelWidth;
6.    propertyRect.x += labelWidth;
7.    EditorGUI.PrefixLabel(position, label);
8.    EditorGUI.PropertyField(propertyRect, property, GUIContent.none);
9. }

Also, for people who are wondering why Im not just using PropertyField, the labels are eating away too much space for my desire, so I am overwriting it this way. If there is another better way please let me know.

 

Anyone has got any idea?

 

Nope, same problem here, seems broken. This and other bugs/flaws have made my initial foray into PropertyDrawers very disappointing.

 

Seems to be still broken in 5.2 =(

My repro case:

"My" custom class:

Code (CSharp):

1. using System;
2. using UnityEngine;
3.  
4. [Serializable]
5. public struct Test
6. {
7.     [SerializeField]
8.     private int intValue;
9. }
10.  

MonoBehaviour with field of the Test type:

Code (CSharp):

1. using UnityEngine;
2.  
3. public class Tooltips : MonoBehaviour
4. {
5.     [Tooltip("I'm invisible tooltip :(")]
6.     public Test test;
7.  
8.     [Tooltip("I'm visible tooltip :)")]
9.     public Vector3 vector;
10. }
11.  

The drawer itself:

Code (CSharp):

1. using UnityEngine;
2. using UnityEditor;
3.  
4. [CustomPropertyDrawer(typeof(Test))]
5. public class TestDrawer : PropertyDrawer
6. {
7.     public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)
8.     {
9.         SerializedProperty intValue = property.FindPropertyRelative("intValue");
10.         EditorGUI.PropertyField(position, intValue, label);
11.     }
12. }

Both property.tooltip and label.tooltip are empty for me.

Sent a bug report (case 728880).

Or I missing something here too?

 

Good news (hopefully) - QA confirmed it's a bug and it was reproduced on the 5.1, 5.2 and 5.3 Unity versions!

 

Thanks for letting us know! I hope we will see a patch fix for this soon

 

3 years later, still the bug present.

Simple workaround to restore the original tooltip to the label: on your PropertyDrawer OnGUI method, add these lines:

Code (CSharp):

1. var tooltipAttribute = fieldInfo.GetAttribute<TooltipAttribute>();
2. label.tooltip = tooltipAttribute != null ? tooltipAttribute.tooltip : "";

Found the right answer here.

Looks like the original issues is simply marked as "won fix", without any detail.
https://issuetracker.unity3d.com/is...eld-of-the-serializedproperty-is-always-empty

 

Sad to hear that! My case where I reported it is having state Closed (case 728880).

It's worth trying submitting a new bug report, perhaps there is a regression or fix didn't get into the main trunk.

 

I can confirm that this bug is still here . I will be using the workaround for now

 

The fix is planned for 2019.4, 2020.2, 2021.1 and is currently in review. Lets see when it lands. I guess it's likely it will in the next weeks.
https://issuetracker.unity3d.com/is...eld-of-the-serializedproperty-is-always-empty

 

Thank you Karl! While you're at the tooltip, could you please remove the restriction from the TooltipAttribute that it can be used on fields only? This should be a trivial change without any risk I assume.

I would like to use the built-in TooltipAttribute to display them as "class comments", see here.

 

Took some time and fix was similar to what I had expected, but at least I am glad that this has been fixed, thank you!

 

Thanks Karl! Would be great if "low priority" wasnt a valid reason for closing an issue. Could that be reviewed? Takes time and dedication to open an issue, is a pitty to have them closed merely for bureaucratic reasons.

 

Karl, do you now what releases are expected to include your fix? My current project is still using Unity 2018.4.30. Is your fix expected to be included in 2018 LTS?

 

Is this fixed in 2020.3 as well? I assumed as much because it's fixed for 2020.2.X but my Custom Inspector still get's empty strings for properties that have a tooltip

 

It has been fixed in Unity 2019.4.24f1 now as well
https://unity3d.com/unity/whats-new/2019.4.24

 

Any reason why this hasn't made it into the 2020.3 LTS, but is in 2020.2?

 

Is it intended that in OnInspectorGUI when you do serializedObject.FindProperty the SerializedProperty.tooltip returns empty, It seems like a bug that there is a tooltip field there yet it always returns and empty string.

 

What Unity version? It has been fixed fairly recently, so the fix has only really made it into the LTS versions from the last couple of months. It's now working for me in the latest 2018.4 / 2019.4

 

Since you're around, did you have a chance to bring this one up yet?
https://forum.unity.com/threads/ser...y-with-tooltip-attribute.288159/#post-6727993

 

Wow, thank you. I really just need the restriction on the TooltipAttribute to be removed, so that I can add the tooltip to a class rather than fields only.

 

That's excellent, thank you very much!

 

This is still broken in 2020.3.14f1

 

Hi Karl, I filed the bug report and it is now in the Issue Tracker:
https://issuetracker.unity3d.com/is...tor-when-a-field-is-generated-with-guicontent

 

Just updating to let anyone reading this know that the unity dev team discussed this and determined that this behaviour is by design. The resolution note:

Using the [Tooltip] doesn't assign to SerializedProperty.tooltip. Hence why the .tooltip field is empty. The PropertyDrawing system uses the attribute tooltip value directly when rendering. So the current behavior is expected.

 

This basically does means we can't draw properties with anything except
EditorGUI \ EditorGUILayout.PropertyField if we would like to customize field behavior and keep tooltip which was set using TooltipAttribute..

How this can be by design?..

@karl_jones

 

That's awesome news, thank you for fixing it or us, @karl_jones ! Looking forward to see it released ^.^

 

Woohoo!!
I've just checked, and it works at 2022.1.0a12, this is just unbelievable, waited for it for the 6 years, thank you so much Karl, you made my day!

 

yep, Karl is doing an incredible job.

 

Absolutely! Looking for more new miracles now!

 

It seems current 2022.1 alpha doesn't have UNITY_2021_3_OR_NEWER conditional yet, hope it'll appear closer to the 2022.1 release, and it's pity we don't have *_OR_NEWER conditionals for every patch =D

So far:

Code (CSharp):

1. [CustomPropertyDrawer(typeof(MyProperty), true)]
2. public class MyPropertyDrawer
3. {
4.   // ...
5.  
6.   private void DrawHint(Rect rect, SerializedProperty property)
7.   {
8. #if UNITY_2021_3_OR_NEWER || UNITY_2022_1_OR_NEWER
9.     var text = property.tooltip;
10. #else
11.     var text = property.GetTooltipWithReflection<MyProperty>();
12. #endif
13.     DrawHint(rect, text);
14.   }
15. }
16.  
17. internal static class SerializedPropertyExtensions
18. {
19. #if !(UNITY_2021_3_OR_NEWER || UNITY_2022_1_OR_NEWER)
20.   public static string GetTooltipWithReflection<T>(this SerializedProperty property)
21.   {
22.     var field = typeof(T).GetField(property.name, BindingFlags.Instance | BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic);
23.     if (field == null)
24.       return null;
25.  
26.     var attribute = field.GetCustomAttribute<TooltipAttribute>(true);
27.     return attribute?.tooltip;
28.   }
29. #endif
30. }
31.  

UNITY_2022_1_OR_NEWER can be removed when (if) 2022.1.0f1 will get UNITY_2021_3_OR_NEWER conditional.

 

Yes! But I don't see "Unity" Resource in the Version Defines packages list (only built-in modules are shown there) or you didn't mean Version Defines feature?..

 

Ah, got it, that's because I'm on Unity 2020.2 where "Unity" Resource wasn't added yet but this is a min version I'm going to support with that feature where I'm using tooltips in Property Drawers :')

 

Added expressions at 2020.3.0, and "Unity" appeared at 2020.2.0 as well but just didn't work which is not a problem for me as min version I'm interested in is 2020.3.22 where Unity resource works perfectly fine, yey, thanks @karl_jones (again)!



This allowed me to replace ugly

UNITY_2021_3_OR_NEWER || UNITY_2022_1_OR_NEWER

with single

TOOLTIP_FIXED

conditional ^^