Description
Describe the project you are working on
Any project
Describe the problem or limitation you are having in your project
It's hard to remember what every individual, reusable scene in my game does after not using them for a while.
Describe the feature / enhancement and how it helps to overcome the problem or limitation
Hovering over nodes in the scene tree that have scripts should display that scripts description in the same way hovering export variables shows their description. If the node has no script attached, or the attached script has no description, display the documentation description for that node type if there is one. Else display nothing like we currently do.
This would make at-a-glance understanding of complex, larger projects much easier as information the developer needs is better presented to them.
Describe how your proposal will work, with code, pseudo-code, mock-ups, and/or diagrams
When an export variable is given a description, that description appears in the Inspector when hovering the field:
## Position to move the player to on dialogue start
@export var player_warp_position: Marker3D
I propose that when a script attached to a node has a description, that description appears in the scene tree when hovering the node:
## Some description here
extends Node3D
If the node has no script attached, or the attached script has no description, display the documentation description for that node type if there is one. Else display nothing like we currently do.
In the same way the Add Child Node popup has a description at the bottom, we could extend this new functionality to the Instantiate Child Scene window and display descriptions at the bottom:
If this enhancement will not be used often, can it be worked around with a few lines of script?
Open up the scene and figure it out the ol' fashioned way.
Is there a reason why this should be core and not an add-on in the asset library?
It's an extension of existing functionality.