summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2023-06-14 09:27:33 +0200
committerRémi Verschelde <rverschelde@gmail.com>2023-06-14 09:27:33 +0200
commit754a52a4ab2e9c65c1e6789aa1e6a3f9047396c9 (patch)
treeac8fa18cf2fd0f40fec06af3b6191ed5c5c54281 /doc
parent16c2fede71a750dfd8d6d515cfaf32fbd5d140b1 (diff)
parent180a5cded1d01e8c8965f009624652ee6ef1807c (diff)
downloadredot-engine-754a52a4ab2e9c65c1e6789aa1e6a3f9047396c9.tar.gz
Merge pull request #78201 from smix8/navmesh_cell_height_4.x
Fix `cell_height` for navigation meshes
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/NavigationMesh.xml4
-rw-r--r--doc/classes/NavigationServer2D.xml4
-rw-r--r--doc/classes/NavigationServer3D.xml19
-rw-r--r--doc/classes/ProjectSettings.xml3
4 files changed, 24 insertions, 6 deletions
diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml
index 5999dc6222..f481fd7099 100644
--- a/doc/classes/NavigationMesh.xml
+++ b/doc/classes/NavigationMesh.xml
@@ -91,10 +91,10 @@
[b]Note:[/b] While baking, this value will be rounded up to the nearest multiple of [member cell_size].
</member>
<member name="cell_height" type="float" setter="set_cell_height" getter="get_cell_height" default="0.25">
- The Y axis cell size to use for fields.
+ The cell height used to rasterize the navigation mesh vertices on the Y axis. Must match with the cell height on the navigation map.
</member>
<member name="cell_size" type="float" setter="set_cell_size" getter="get_cell_size" default="0.25">
- The XZ plane cell size to use for fields.
+ The cell size used to rasterize the navigation mesh vertices on the XZ plane. Must match with the cell size on the navigation map.
</member>
<member name="detail_sample_distance" type="float" setter="set_detail_sample_distance" getter="get_detail_sample_distance" default="6.0">
The sampling distance to use when generating the detail mesh, in cell unit.
diff --git a/doc/classes/NavigationServer2D.xml b/doc/classes/NavigationServer2D.xml
index fb23d22127..f46f2912b3 100644
--- a/doc/classes/NavigationServer2D.xml
+++ b/doc/classes/NavigationServer2D.xml
@@ -339,7 +339,7 @@
<return type="float" />
<param index="0" name="map" type="RID" />
<description>
- Returns the map cell size.
+ Returns the map cell size used to rasterize the navigation mesh vertices.
</description>
</method>
<method name="map_get_closest_point" qualifiers="const">
@@ -431,7 +431,7 @@
<param index="0" name="map" type="RID" />
<param index="1" name="cell_size" type="float" />
<description>
- Set the map cell size used to weld the navigation mesh polygons.
+ Sets the map cell size used to rasterize the navigation mesh vertices. Must match with the cell size of the used navigation meshes.
</description>
</method>
<method name="map_set_edge_connection_margin">
diff --git a/doc/classes/NavigationServer3D.xml b/doc/classes/NavigationServer3D.xml
index 6f406aa629..ac9646da4a 100644
--- a/doc/classes/NavigationServer3D.xml
+++ b/doc/classes/NavigationServer3D.xml
@@ -367,11 +367,18 @@
Returns all navigation agents [RID]s that are currently assigned to the requested navigation [param map].
</description>
</method>
+ <method name="map_get_cell_height" qualifiers="const">
+ <return type="float" />
+ <param index="0" name="map" type="RID" />
+ <description>
+ Returns the map cell height used to rasterize the navigation mesh vertices on the Y axis.
+ </description>
+ </method>
<method name="map_get_cell_size" qualifiers="const">
<return type="float" />
<param index="0" name="map" type="RID" />
<description>
- Returns the map cell size.
+ Returns the map cell size used to rasterize the navigation mesh vertices on the XZ plane.
</description>
</method>
<method name="map_get_closest_point" qualifiers="const">
@@ -483,12 +490,20 @@
Sets the map active.
</description>
</method>
+ <method name="map_set_cell_height">
+ <return type="void" />
+ <param index="0" name="map" type="RID" />
+ <param index="1" name="cell_height" type="float" />
+ <description>
+ Sets the map cell height used to rasterize the navigation mesh vertices on the Y axis. Must match with the cell height of the used navigation meshes.
+ </description>
+ </method>
<method name="map_set_cell_size">
<return type="void" />
<param index="0" name="map" type="RID" />
<param index="1" name="cell_size" type="float" />
<description>
- Set the map cell size used to weld the navigation mesh polygons.
+ Sets the map cell size used to rasterize the navigation mesh vertices on the XZ plane. Must match with the cell size of the used navigation meshes.
</description>
</method>
<method name="map_set_edge_connection_margin">
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml
index 57387aa65a..ce36a0336d 100644
--- a/doc/classes/ProjectSettings.xml
+++ b/doc/classes/ProjectSettings.xml
@@ -1952,6 +1952,9 @@
<member name="navigation/2d/use_edge_connections" type="bool" setter="" getter="" default="true">
If enabled 2D navigation regions will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. This setting only affects World2D default navigation maps.
</member>
+ <member name="navigation/3d/default_cell_height" type="float" setter="" getter="" default="0.25">
+ Default cell height for 3D navigation maps. See [method NavigationServer3D.map_set_cell_height].
+ </member>
<member name="navigation/3d/default_cell_size" type="float" setter="" getter="" default="0.25">
Default cell size for 3D navigation maps. See [method NavigationServer3D.map_set_cell_size].
</member>