Is there something like [Tooltip()] attribute?

🌵 Needle Engine
1

Hi there, in Unity I make intense use of the [Tooltip()] attribute, but can’t find something comparable in Needle. When I write a tooltip in the C# sidecar class, the tooltip is gone the next time I change the TS script.

Original Post on Discord

by user 689743366355025931

2

Hi, that’s something I was missing a couple of times as well - I’ll make a task for that to add it

3

I’m all for not documenting in code because it should be self-explanatory, but for the user front end in Unity I often use it for clarification. So thumbs up for this feature. :slightly_smiling_face:

by user 689743366355025931

4

If you run a clean install the component compiler will update and you should be able to write tooltips like this
image.png
image.png

5

I will not be able to solve this. This is what I tried so far.

//@tooltip 11 If true, the element will be hidden on enable and shown on disable
@serializeable()
switchOnEnableDisable: boolean = true;

@serializeable()
//@tooltip 22 If true, the element will be hidden on enable and shown on disable
switchOnStartDestroy: boolean = false;

//@tooltip Foo is bar
foobar: boolean = false;

by user 689743366355025931

6

Where is your script in the project? Is in in src/scripts ?

7

Yes. It is \src\scripts\ToggleHTMLElement.ts

by user 689743366355025931

8

and what version of the component compiler do you see?
image.png

9

Cases 1 and 3 work for me (in your example above)
20230803-081912_Needle_Engine_2021_URP_-Buttons-_Windows_Mac_L-logo.mp4

10

1.9.4 … maybe I’am out dated?

by user 689743366355025931

11

Can you try running a clean install? Via Alt+Install on the ExportInfo

12

The tooltip was added in 1.10.0

13

Ahh… OK! The clean install raised the Generator version. And now Tooltips are present. Thank you.

Fyi: while the update Unity Console puts out some errors like “EBUSY: resource busy or locked”. This is because VSCode or VS or bothe are locking some Unity files. Solution to this is simply closing VSCode & VS and try again. :wink:

by user 689743366355025931

14

Yes im aware of that but im not sure what a good solution is (since files can be locked by any process technically) - do you think adding a special log when this message appears with some potential reasons would help?

15

E.g. along the lines of “this may be of visual studio code…”

16

It is an UNity “bug” or behaviour that I conquer for years. Its has nothing to do with Needle. But faceing this issue sometime needs lots of time to tackle, so I do want inform about that. :slightly_smiling_face:

by user 689743366355025931

17

I think in this case (when you run Clean Install and you see the message) then it’s sometimes VSCode that is locking files and not Unity’s fault^^

18

At least I’ve had this multiple times