Add documentation about .gdextension file #9383
Conversation
paddy-exe
added
content:new page
paddy-exe
force-pushed
the
gdextension-file-quick-reference
branch
from
2b73f33
to
f567fa1
Compare
paddy-exe
force-pushed
the
gdextension-file-quick-reference
branch
from
b47f96d
to
90e7155
Compare
paddy-exe
force-pushed
the
gdextension-file-quick-reference
branch
from
90e7155
to
ac065d9
Compare
paddy-exe
force-pushed
the
gdextension-file-quick-reference
branch
from
ac065d9
to
91b93c8
Compare
paddy-exe
force-pushed
the
gdextension-file-quick-reference
branch
from
91b93c8
to
cea6ef0
Compare
|
Thanks for the feedback! Should be good now |
paddy-exe
force-pushed
the
gdextension-file-quick-reference
branch
from
cea6ef0
to
ecc21c6
Compare
|
Updated to feedback, added another sections about icons support and removed the icons section from the Example page as it makes no sense to have it double |
| | **reloadable** | Reloads the extension upon recompilation. Reloading is not supported for every exposed class. | | ||
| | | This flag should be mainly used for developing or debugging an extension. | |
There was a problem hiding this comment.
What is meant by "Reloading is not supported for every exposed class"? It should work for any class, although, some can have additional considerations, for example, editor plugins.
It may be worth pointing out that not all GDExtension bindings support it? We could mention that godot-cpp for Godot 4.2+ does - I'm not sure it makes sense trying to list other bindings, because that list will always be growing
There was a problem hiding this comment.
I wasn't sure if it is already supported for every class especially the editor plugins classes due to how they are handled with reloading. If are you certain then I will change it. I would only list the official godot-cpp support as we other language bindings can say themselves if they support reload support or not
There was a problem hiding this comment.
Updated now. Let me know what you think
| | **reloadable** | Reloads the extension upon recompilation. Reloading is not supported for every exposed class. | | ||
| | | This flag should be mainly used for developing or debugging an extension. | | ||
| +-------------------------------+------------------------------------------------------------------------------------------------------+ | ||
| | **android_aar_plugin** | The GDExtension is part of a :ref:`v2 Android plugin <doc_android_plugin>`. During export this flag | |
There was a problem hiding this comment.
It's not clear from this description that this is a boolean property. Perhaps we should be listing the type for each property?
There was a problem hiding this comment.
I added a Type section in the table and set either String or Boolean in there
paddy-exe
force-pushed
the
gdextension-file-quick-reference
branch
from
ecc21c6
to
0dda1da
Compare
Update tutorials/scripting/gdextension/gdextension_file.rst
paddy-exe
force-pushed
the
gdextension-file-quick-reference
branch
from
0dda1da
to
7695474
Compare
This is a PR in the effort to improve the GDExtension docs for users
Adds details how to configure the
.gdextensionfile and aids as a quick reference guide to add support for platforms