Update GDExtension tutorial with the hot reload feature #9618
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Bromeon
reviewed
Jul 17, 2024
| @@ -364,7 +364,8 @@ loaded for each platform and the entry function for the module. It is called ``g | |||
| [configuration] | |||
|
|
|||
| entry_symbol = "example_library_init" | |||
| compatibility_minimum = "4.1" | |||
| compatibility_minimum = "4.2" | |||
There was a problem hiding this comment.
Is there a reason to bump this? I would rather have people extend their compatibility ranges than chasing latest. Maybe the trade-off could be elaborated in the text.
Comment on lines
392
to
393
| The ``reloadable`` flag enables your extension to be automatically loaded every time you recompile it, | ||
| without needing to restart the editor. This only works if you compile your extension in debug mode. |
There was a problem hiding this comment.
Maybe mention "loaded by the editor". I had lots of user being confused why "hot reloading" cannot reload in a running game. The term that Godot chose here is rather unfortunate.
paddy-exe
requested changes
Jul 17, 2024
Comment on lines
510
to
514
| .. note:: | ||
|
|
||
| The hot reloading feature only works of you compiled your library with debug mode (default). | ||
| Also make sure it's enabled in the .gdextension file as shown above. | ||
|
|
There was a problem hiding this comment.
This seem to be doubled with the changes above. I would rather specify the section in the gdextension file explanation of the [configuration] section
paddy-exe
requested changes
Jul 18, 2024
paddy-exe
approved these changes
Jul 19, 2024
| @@ -388,6 +389,8 @@ loaded for each platform and the entry function for the module. It is called ``g | |||
| This file contains a ``configuration`` section that controls the entry function of the module. | |||
| You should also set the minimum compatible Godot version with ``compatability_minimum``, | |||
| which prevents older version of Godot from trying to load your extension. | |||
| The ``reloadable`` flag enables your extension to be automatically reloaded by the editor every time you recompile it, | |||
There was a problem hiding this comment.
Suggested change
| The ``reloadable`` flag enables your extension to be automatically reloaded by the editor every time you recompile it, | |
| The ``reloadable`` flag enables automatic reloading of your extension by the editor every time you recompile it, |
AThousandShips
added
area:manual
Although the tutorial assumed the hot reload feature, it wasn't enabled in the example config file. Also it didn't mention that it only works if it's compiled in debug mode.
dsnopek
approved these changes
Aug 7, 2024
mhilbrunner
approved these changes
Aug 14, 2024
|
Merged. Thanks and congrats on your first merged contribution! |
Lukas-Fletcher
pushed a commit
to Lukas-Fletcher/godot-docs
that referenced
this pull request
Aug 24, 2024
…9618) Although the tutorial assumed the hot reload feature, it wasn't enabled in the example config file. Also it didn't mention that it only works if it's compiled in debug mode.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Although the tutorial assumed the hot reload feature, it wasn't enabled in the example config file. Also it didn't mention that it only works if it's compiled in debug mode.