Skip to content

Commit f66ca15

Browse files
authored
Merge pull request #10821 from AThousandShips/nav_size_update
[Navigation] Update contributing docs to reflect 2D navigation changes
2 parents ed79f7b + 9aecfc7 commit f66ca15

File tree

2 files changed

+15
-18
lines changed

2 files changed

+15
-18
lines changed

contributing/development/compiling/optimizing_for_size.rst

+2-7
Original file line numberDiff line numberDiff line change
@@ -150,11 +150,6 @@ Tools must be disabled in order to use this flag, as the editor is not designed
150150
to operate without 3D support. Without it, the binary size can be reduced
151151
by about 15%.
152152

153-
.. note::
154-
155-
Disabling 3D support also disables all navigation. This includes 2D navigation,
156-
as it uses the 3D navigation system internally.
157-
158153
Disabling advanced GUI objects
159154
------------------------------
160155

@@ -220,7 +215,7 @@ a lot of them:
220215

221216
::
222217

223-
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
218+
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
224219

225220
If this proves not to work for your use case, you should review the list of
226221
modules and see which ones you actually still need for your game (e.g. you might
@@ -251,7 +246,7 @@ following:
251246
module_msdfgen_enabled= "no"
252247
module_multiplayer_enabled = "no"
253248
module_noise_enabled = "no"
254-
module_navigation_enabled = "no"
249+
module_navigation_3d_enabled = "no"
255250
module_ogg_enabled = "no"
256251
module_openxr_enabled = "no"
257252
module_raycast_enabled = "no"

contributing/development/core_and_modules/unit_testing.rst

+13-11
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)