Browse Source

Merge pull request #10821 from AThousandShips/nav_size_update

[Navigation] Update contributing docs to reflect 2D navigation changes
Max Hilbrunner 3 months ago
parent
commit
f66ca150f5

+ 2 - 7
contributing/development/compiling/optimizing_for_size.rst

@@ -150,11 +150,6 @@ Tools must be disabled in order to use this flag, as the editor is not designed
 to operate without 3D support. Without it, the binary size can be reduced
 to operate without 3D support. Without it, the binary size can be reduced
 by about 15%.
 by about 15%.
 
 
-.. note::
-
-    Disabling 3D support also disables all navigation. This includes 2D navigation,
-    as it uses the 3D navigation system internally.
-
 Disabling advanced GUI objects
 Disabling advanced GUI objects
 ------------------------------
 ------------------------------
 
 
@@ -220,7 +215,7 @@ a lot of them:
 
 
 ::
 ::
 
 
-    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
+    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
 
 
 If this proves not to work for your use case, you should review the list of
 If this proves not to work for your use case, you should review the list of
 modules and see which ones you actually still need for your game (e.g. you might
 modules and see which ones you actually still need for your game (e.g. you might
@@ -251,7 +246,7 @@ following:
     module_msdfgen_enabled= "no"
     module_msdfgen_enabled= "no"
     module_multiplayer_enabled = "no"
     module_multiplayer_enabled = "no"
     module_noise_enabled = "no"
     module_noise_enabled = "no"
-    module_navigation_enabled = "no"
+    module_navigation_3d_enabled = "no"
     module_ogg_enabled = "no"
     module_ogg_enabled = "no"
     module_openxr_enabled = "no"
     module_openxr_enabled = "no"
     module_raycast_enabled = "no"
     module_raycast_enabled = "no"

+ 13 - 11
contributing/development/core_and_modules/unit_testing.rst

@@ -271,17 +271,19 @@ Special tags in test case names
 
 
 These tags can be added to the test case name to modify or extend the test environment:
 These tags can be added to the test case name to modify or extend the test environment:
 
 
-+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| **Tag**           | **Description**                                                                                                                                                      |
-+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ``[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>`.      |
-+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ``[Editor]``      | Like ``[SceneTree]``, but with additional editor-related infrastructure available, such as :ref:`EditorSettings<class_EditorSettings>`.                              |
-+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ``[Audio]``       | Initializes the :ref:`AudioServer<class_AudioServer>` using a mock audio driver.                                                                                     |
-+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ``[Navigation]``  | Creates the default 2D/3D navigation servers and makes them available for testing.                                                                                   |
-+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
++--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| **Tag**            | **Description**                                                                                                                                                      |
++--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``[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>`.      |
++--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``[Editor]``       | Like ``[SceneTree]``, but with additional editor-related infrastructure available, such as :ref:`EditorSettings<class_EditorSettings>`.                              |
++--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``[Audio]``        | Initializes the :ref:`AudioServer<class_AudioServer>` using a mock audio driver.                                                                                     |
++--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``[Navigation2D]`` | Creates the default 2D navigation server and makes it available for testing.                                                                                         |
++--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``[Navigation3D]`` | Creates the default 3D navigation server and makes it available for testing.                                                                                         |
++--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 
 You can use them together to combine multiple test environment extensions.
 You can use them together to combine multiple test environment extensions.