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

Write documentation for runtime classes #10253

Open
dsnopek opened this issue Nov 12, 2024 · 0 comments
Open

Write documentation for runtime classes #10253

dsnopek opened this issue Nov 12, 2024 · 0 comments

Comments

@dsnopek
Copy link
Contributor

dsnopek commented Nov 12, 2024

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<T>() 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 :-)

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

No branches or pull requests

1 participant