You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Whenever a custom Node is successfully added, using add_custom_type(), be it with a Plugin or with another Script, the custom Node will have no description and it'll have no functionality regarding ## comments, thus it won't also create a documentary for that custom Node.
(Exception is applied on the Property List, it uses the ## comments there.)
class_name alone does work as it's intended, however it'll make the custom Node have the script's name be placed next to it in parenthesizes. add_custom_type() should be able to work the same way as class_name, but without the script's name be attached next to it.
Examples:
Image 1 represents the bug. A custom Node called VisibilityModifier is inheriting VisibleOnScreenNotifier2D.
Since VisibilityModifier has no documentary, it only shows the Node's documentary, that's inheriting from, like it never existed to begin with.
Image 2 shows how it should look like originally, after adding the script as a custom Node. It should have a documentary, and description present.
Image 3 represents the bug. This custom Node has been added successfully, however the description is not present.
Image 4 shows how it should look like originally, after adding the script as a custom Node. It should show it's description as it's expected.
Steps to reproduce
Create a new Project (for testing purposes)
Create a new Script (GDScript preferrably)
Have ## comments after extends Node2D, that should be the description of the Script
Create a Plugin and inside it, use add_custom_type() to add the new Script as a custom Node (On Plugin Enabled)
The bug should be visible, when trying to add the custom Node to the Scene.
Trying to open the custom Node's documentary (by Right Clicking on the custom Node) will open the Node's documentary that it inherits from, in that case, it should show the Node2D class' documentary.
Tested versions
Reproducable in:
System information
Linux Mint 22
Issue description
Whenever a custom Node is successfully added, using
add_custom_type()
, be it with a Plugin or with another Script, the custom Node will have no description and it'll have no functionality regarding ## comments, thus it won't also create a documentary for that custom Node.class_name
alone does work as it's intended, however it'll make the custom Node have the script's name be placed next to it in parenthesizes.add_custom_type()
should be able to work the same way asclass_name
, but without the script's name be attached next to it.Examples:
Image 1 represents the bug. A custom Node called
VisibilityModifier
is inheritingVisibleOnScreenNotifier2D
.Since
VisibilityModifier
has no documentary, it only shows the Node's documentary, that's inheriting from, like it never existed to begin with.Image 2 shows how it should look like originally, after adding the script as a custom Node. It should have a documentary, and description present.
Image 3 represents the bug. This custom Node has been added successfully, however the description is not present.
Image 4 shows how it should look like originally, after adding the script as a custom Node. It should show it's description as it's expected.
Steps to reproduce
extends Node2D
, that should be the description of the Scriptadd_custom_type()
to add the new Script as a custom Node (On Plugin Enabled)Node2D
class' documentary.Minimal reproduction project (MRP)
Tested on Redot's 4.3 Stable Version:
custom-node-documentary-test.zip
The text was updated successfully, but these errors were encountered: