Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Custom Node added with add_custom_type() will not add documentary and functionality with ## comments #889

Open
RIH-Cellegen opened this issue Nov 30, 2024 · 0 comments

Comments

@RIH-Cellegen
Copy link

RIH-Cellegen commented Nov 30, 2024

Tested versions

Reproducable in:

  • All Godot 4.x - 4.4 Dev versions
  • All Redot 4.x - 4.3 Stable versions

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.

(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
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.

image2
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.

picture4
Image 3 represents the bug. This custom Node has been added successfully, however the description is not present.

image3
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.

Minimal reproduction project (MRP)

Tested on Redot's 4.3 Stable Version:
custom-node-documentary-test.zip

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Open
Development

No branches or pull requests

2 participants