Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto
  • ¿Algo no está bien?
#889 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
52/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
cpp, godot
Área
devtools

Línea de trabajo

Start at the editor's add_custom_type() entry point and trace how it exposes the custom Node's script description and ## comments; use the linked minimal reproduction project to reproduce the issue. Done means the custom Node displays its own description and documentation when added to a scene, while property-list comments continue to work.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

bug topic:editor topic:gdscript
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

Lenguaje dominante
C++
Estrellas
6.1k
Forks
337
Merge medio
1 d 2 h
PR fusionados (30 d)
35

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Redot-Engine/redot-engine

Todos los issues de Redot-Engine/redot-engine

Issues similares

Más issues de C++

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.