Skip to content

Commit 9aecfc7

Browse files
[Navigation] Update contributing docs to reflect 2D navigation changes
1 parent 9924a69 commit 9aecfc7

File tree

2 files changed

+15
-18
lines changed

2 files changed

+15
-18
lines changed

contributing/development/compiling/optimizing_for_size.rst

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -144,11 +144,6 @@ Tools must be disabled in order to use this flag, as the editor is not designed
144144
to operate without 3D support. Without it, the binary size can be reduced
145145
by about 15%.
146146

147-
.. note::
148-
149-
Disabling 3D support also disables all navigation. This includes 2D navigation,
150-
as it uses the 3D navigation system internally.
151-
152147
Disabling advanced GUI objects
153148
------------------------------
154149

@@ -214,7 +209,7 @@ a lot of them:
214209

215210
::
216211

217-
scons target=template_release module_basis_universal_enabled=no module_bmp_enabled=no module_camera_enabled=no module_csg_enabled=no module_dds_enabled=no module_enet_enabled=no module_gridmap_enabled=no module_hdr_enabled=no module_jsonrpc_enabled=no module_ktx_enabled=no module_mbedtls_enabled=no module_meshoptimizer_enabled=no module_minimp3_enabled=no module_mobile_vr_enabled=no module_msdfgen_enabled=no module_multiplayer_enabled=no module_noise_enabled=no module_navigation_enabled=no module_ogg_enabled=no module_openxr_enabled=no module_raycast_enabled=no module_regex_enabled=no module_squish_enabled=no module_svg_enabled=no module_tga_enabled=no module_theora_enabled=no module_tinyexr_enabled=no module_upnp_enabled=no module_vhacd_enabled=no module_vorbis_enabled=no module_webrtc_enabled=no module_websocket_enabled=no module_webxr_enabled=no module_zip_enabled=no
212+
scons target=template_release module_basis_universal_enabled=no module_bmp_enabled=no module_camera_enabled=no module_csg_enabled=no module_dds_enabled=no module_enet_enabled=no module_gridmap_enabled=no module_hdr_enabled=no module_jsonrpc_enabled=no module_ktx_enabled=no module_mbedtls_enabled=no module_meshoptimizer_enabled=no module_minimp3_enabled=no module_mobile_vr_enabled=no module_msdfgen_enabled=no module_multiplayer_enabled=no module_noise_enabled=no module_navigation_3d_enabled=no module_ogg_enabled=no module_openxr_enabled=no module_raycast_enabled=no module_regex_enabled=no module_squish_enabled=no module_svg_enabled=no module_tga_enabled=no module_theora_enabled=no module_tinyexr_enabled=no module_upnp_enabled=no module_vhacd_enabled=no module_vorbis_enabled=no module_webrtc_enabled=no module_websocket_enabled=no module_webxr_enabled=no module_zip_enabled=no
218213

219214
If this proves not to work for your use case, you should review the list of
220215
modules and see which ones you actually still need for your game (e.g. you might
@@ -245,7 +240,7 @@ following:
245240
module_msdfgen_enabled= "no"
246241
module_multiplayer_enabled = "no"
247242
module_noise_enabled = "no"
248-
module_navigation_enabled = "no"
243+
module_navigation_3d_enabled = "no"
249244
module_ogg_enabled = "no"
250245
module_openxr_enabled = "no"
251246
module_raycast_enabled = "no"

contributing/development/core_and_modules/unit_testing.rst

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -271,17 +271,19 @@ Special tags in test case names
271271

272272
These tags can be added to the test case name to modify or extend the test environment:
273273

274-
+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
275-
| **Tag** | **Description** |
276-
+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
277-
| ``[SceneTree]`` | Required for test cases that rely on a scene tree with MessageQueue to be available. It also enables a mock rendering server and :ref:`ThemeDB<class_ThemeDB>`. |
278-
+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
279-
| ``[Editor]`` | Like ``[SceneTree]``, but with additional editor-related infrastructure available, such as :ref:`EditorSettings<class_EditorSettings>`. |
280-
+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
281-
| ``[Audio]`` | Initializes the :ref:`AudioServer<class_AudioServer>` using a mock audio driver. |
282-
+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
283-
| ``[Navigation]`` | Creates the default 2D/3D navigation servers and makes them available for testing. |
284-
+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
274+
+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
275+
| **Tag** | **Description** |
276+
+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
277+
| ``[SceneTree]`` | Required for test cases that rely on a scene tree with MessageQueue to be available. It also enables a mock rendering server and :ref:`ThemeDB<class_ThemeDB>`. |
278+
+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
279+
| ``[Editor]`` | Like ``[SceneTree]``, but with additional editor-related infrastructure available, such as :ref:`EditorSettings<class_EditorSettings>`. |
280+
+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
281+
| ``[Audio]`` | Initializes the :ref:`AudioServer<class_AudioServer>` using a mock audio driver. |
282+
+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
283+
| ``[Navigation2D]`` | Creates the default 2D navigation server and makes it available for testing. |
284+
+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
285+
| ``[Navigation3D]`` | Creates the default 3D navigation server and makes it available for testing. |
286+
+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
285287

286288
You can use them together to combine multiple test environment extensions.
287289

0 commit comments

Comments
 (0)