godotengine / godotengine/godot-docs

Write documentation for runtime classes

Open
#10,253 0 comments 0 reactions 0 assignees View on GitHub
enhancement topic:gdextension
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

Runtime classes were added in Godot 4.3, and can be used both from GDExtension and modules (although, there's no reason to use from a module unless you are converting a GDExtension to a module), but we don't have any documentation for them yet.

Should cover `GDREGISTER_RUNTIME_CLASS()` and cover what that actually means for the class.

A common issue folks hit with godot-cpp, is attempting to do `Object::cast_to()` to the class in an editor plugin, and being confused as to why they get `nullptr`, so that should be explained as well. (The reason is that runtime classes aren't created in the editor by default, instead the native parent class is created, so you can't cast to the real class.)

Creating this issue so contributors can take on this task if they'd like :-)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.