Skip to content

Commit

Permalink
Update GDExtension tutorial with the hot reload feature
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Szotyi2501 committed Jul 18, 2024
1 parent 1d72c66 commit 673968d
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions tutorials/scripting/gdextension/gdextension_cpp_example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -365,6 +365,7 @@ loaded for each platform and the entry function for the module. It is called ``g
entry_symbol = "example_library_init"
compatibility_minimum = "4.1"
reloadable = true
[libraries]
Expand All @@ -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,
without needing to restart the editor. This only works if you compile your extension in debug mode (default).

The ``libraries`` section is the important bit: it tells Godot the location of the
dynamic library in the project's filesystem for each supported platform. It will
Expand Down

0 comments on commit 673968d

Please sign in to comment.