Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta
  • Qualcosa non va?
#889 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
52/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
cpp, godot
Ambito
devtools

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
C++
Stelle
6.1k
Fork
337
Merge medio
1g 2h
PR unite (30g)
35

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Redot-Engine/redot-engine

Tutte le issue di Redot-Engine/redot-engine

Issue simili

Altre issue su C++

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.