Print the class when using Node's print_tree()/print_tree_pretty()

[Calinou]

The class name may not always be obvious, especially when nodes are renamed from their default names. _to_string() is called if overridden in the node's script. By default, the node type and instance ID are displayed.

This also adds rich formatting, including for _to_string() handlers if displayed within print_tree() or print_tree_pretty().

See godotengine/godot-proposals#2953 (comment).

Preview (outdated)

print_tree()

Before

.
ThisIsNode3D
ThisIsNode3D/OccluderInstance3D
ThisIsNode3D/MeshInstance3D2
ThisIsNode3D/SomeCSGBox
ThisIsNode3D/SomeCSGBox/CSGCylinder3D
ThisIsNode3D/MeshInstance3D
ThisIsNode3D/MeshInstance3D3
ThisIsNode3D/VoxelGI
ThisIsNode3D/OmniLight3D
ThisIsNode3D/Camera3D
ThisIsNode3D/Sprite2D
ThisIsNode3D/WorldEnvironment
ThisIsNode3D/DirectionalLight3D

After

Screenshot from the Visual Studio Code terminal.

print_tree_pretty()

Before

 ┖╴root
    ┖╴ThisIsNode3D
       ┠╴OccluderInstance3D
       ┠╴MeshInstance3D2
       ┠╴SomeCSGBox
       ┃  ┖╴CSGCylinder3D
       ┠╴MeshInstance3D
       ┠╴MeshInstance3D3
       ┠╴VoxelGI
       ┠╴OmniLight3D
       ┠╴Camera3D
       ┠╴Sprite2D
       ┠╴WorldEnvironment
       ┖╴DirectionalLight3D

After

Screenshot from the Visual Studio Code terminal.

[xix-xeaon]

Yeah it's noisy. It would probably work well with colors though. BTW, I think space before the colon is much cleaner; Name :Type. The colon denotes a type, so it should be next to the type - not the name. I write it like that in all languages I use. Most people probably disagree because they're used to the other way, but oh well.

[Calinou]

It would probably work well with colors though.

Unfortunately, we can't use colors in the Output panel until #33541 is merged. That said, #33541 would require an ANSI conversion routine (or at least a BBCode tag stripping routine) for console output to remain readable.

BTW, I think space before the colon is much cleaner; Name :Type

I'd prefer to use something that looks like the recommended type hinting syntax in the GDScript style guide.

[kleonc]

I use print_tree_pretty() to print parts of the editor's tree and in that case printing name: type often isn't really helpful since most nodes in the editor have no meaningful name and there are many nodes of the same type. And if I have a reference to some specific node then printing it like print(node) outputs the result of get_string() which is by default (for nodes) name:[type:instance_id] (and user can customize this by overriding _to_string() for custom nodes). So it would be nice to be able to make print_tree_pretty() (and print_tree(), I guess) print the nodes by using the result of to_string(). I'd say these methods are used mainly for debug purposes and hence allowing more verbose (and customizable) output would be good. Maybe an additional use_to_string = false flag?

[reduz]

Can this be made to use colors now?

[Calinou]

Can this be made to use colors now?

This should be possible with print_rich() now 🙂

Edit: I modified this PR to use print_line_rich() (C++ version of print_rich()). See OP for updated screenshots.

[Calinou]

Rebased and tweaked to follow @kleonc's comment. The String() handler is now called to display the node type. By default, it displays the node type and instance ID unless _to_string() is overridden.

print_tree()

print_tree_pretty()

It's even possible to use BBCode in either of these if you feel like it. It will display correctly in the editor Output panel and console output: