virtualx-engine/modules/navigation
Rémi Verschelde 39facb35a0 SCons: Unify tools/target build type configuration
Implements https://github.com/godotengine/godot-proposals/issues/3371.

New `target` presets
====================

The `tools` option is removed and `target` changes to use three new presets,
which match the builds users are familiar with. These targets control the
default optimization level and enable editor-specific and debugging code:

- `editor`: Replaces `tools=yes target=release_debug`.
  * Defines: `TOOLS_ENABLED`, `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_debug`: Replaces `tools=no target=release_debug`.
  * Defines: `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_release`: Replaces `tools=no target=release`.
  * Defines: `-O3`/`/O2`

New `dev_build` option
======================

The previous `target=debug` is now replaced by a separate `dev_build=yes`
option, which can be used in combination with either of the three targets,
and changes the following:

- `dev_build`: Defines `DEV_ENABLED`, disables optimization (`-O0`/`/0d`),
  enables generating debug symbols, does not define `NDEBUG` so `assert()`
  works in thirdparty libraries, adds a `.dev` suffix to the binary name.

Note: Unlike previously, `dev_build` defaults to off so that users who
compile Godot from source get an optimized and small build by default.
Engine contributors should now set `dev_build=yes` in their build scripts or
IDE configuration manually.

Changed binary names
====================

The name of generated binaries and object files are changed too, to follow
this format:

`godot.<platform>.<target>[.dev][.double].<arch>[.<extra_suffix>][.<ext>]`

For example:
- `godot.linuxbsd.editor.dev.arm64`
- `godot.windows.template_release.double.x86_64.mono.exe`

Be sure to update your links/scripts/IDE config accordingly.

More flexible `optimize` and `debug_symbols` options
====================================================

The optimization level and whether to generate debug symbols can be further
specified with the `optimize` and `debug_symbols` options. So the default
values listed above for the various `target` and `dev_build` combinations
are indicative and can be replaced when compiling, e.g.:

`scons p=linuxbsd target=template_debug dev_build=yes optimize=debug`
will make a "debug" export template with dev-only code enabled, `-Og`
optimization level for GCC/Clang, and debug symbols. Perfect for debugging
complex crashes at runtime in an exported project.
2022-09-26 16:31:46 +02:00
..
editor Rename EditorInterface.get_editor_main_control to get_editor_main_screen 2022-09-07 03:01:58 +03:00
config.py
godot_navigation_server.cpp Add NavigationPathQuery 2022-09-20 22:20:11 +02:00
godot_navigation_server.h Add NavigationPathQuery 2022-09-20 22:20:11 +02:00
nav_base.h Added node for Navigation links 2022-08-26 22:05:15 -07:00
nav_link.cpp Added node for Navigation links 2022-08-26 22:05:15 -07:00
nav_link.h Added node for Navigation links 2022-08-26 22:05:15 -07:00
nav_map.cpp Added node for Navigation links 2022-08-26 22:05:15 -07:00
nav_map.h Added node for Navigation links 2022-08-26 22:05:15 -07:00
nav_region.cpp Added node for Navigation links 2022-08-26 22:05:15 -07:00
nav_region.h Added node for Navigation links 2022-08-26 22:05:15 -07:00
nav_rid.h Style: Remove inconsistently used @author docstrings 2022-01-04 20:42:50 +01:00
nav_utils.h Added node for Navigation links 2022-08-26 22:05:15 -07:00
navigation_mesh_generator.cpp Exclude disabled CollisionShapes from Navigationmesh baking 2022-09-14 10:41:33 +02:00
navigation_mesh_generator.h Fix navmesh baking 2022-04-08 21:01:59 +02:00
register_types.cpp Refactor module initialization 2022-05-04 17:34:51 +02:00
register_types.h Refactor module initialization 2022-05-04 17:34:51 +02:00
rvo_agent.cpp Fix crash of navigation agents callback when object is invalid 2022-06-14 13:04:02 +02:00
rvo_agent.h Style: Remove inconsistently used @author docstrings 2022-01-04 20:42:50 +01:00
SCsub SCons: Unify tools/target build type configuration 2022-09-26 16:31:46 +02:00