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

GDExtension add documentation on hot reloading feature (C++) #9532

Closed
Zacrain opened this issue Jun 23, 2024 · 1 comment
Closed

GDExtension add documentation on hot reloading feature (C++) #9532

Zacrain opened this issue Jun 23, 2024 · 1 comment

Comments

@Zacrain
Copy link
Contributor

Zacrain commented Jun 23, 2024

Your Godot version:
v4.2.2.stable.official [15073afe3]

Issue description:
With PR 80284 ( godotengine/godot#80284 ) hot reloading was added. I encountered that I wasn't able to use that feature until I looked for and read a bit on the pull request page. For example, it is necessary to add the configuration parameter:

reloadable = true

to the [configuration] section of the corresponding .gdextension file. Yet this seems to be currently undocumented. (Furthermore I have encountered some issues, which I've detailed over at godot-cpp: godotengine/godot-cpp#1502 .)

I suppose the documentation on GDExtension with the C++ example would be a good place to add it. Furthermore, it might be meaningful to add a section detailing the .gdextension file and all possible parameters as I haven't found a separate documentation on that.

Regarding the additional documentation in the GDExtension C++ Example, I'll provide a first draft in a pull request probably in the next couple of days. The latter, whether such an overview manual page might be meaningufl, I'll leave open for discussion.

URL to the documentation page (if already existing):
https://docs.godotengine.org/en/stable/tutorials/scripting/gdextension/gdextension_cpp_example.html

@paddy-exe
Copy link
Contributor

Thanks for raising this issue
Fixed already by #9383

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

2 participants