Skip to content

Commit 8bc0743

Browse files
committed
Add a note about navigation mesh baking issues when using 0 for the agent_radius
1 parent 1218a16 commit 8bc0743

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

doc/classes/NavigationMesh.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,11 +95,12 @@
9595
<member name="agent_radius" type="float" setter="set_agent_radius" getter="get_agent_radius" default="0.5">
9696
The distance to erode/shrink the walkable area of the heightfield away from obstructions.
9797
[b]Note:[/b] While baking, this value will be rounded up to the nearest multiple of [member cell_size].
98+
[b]Note:[/b] The radius must be positive. If the radius is [code]0.0[/code], it won't be possible to fix invalid outline overlaps and other precision errors during the baking process. As a result, some obstacles may be excluded incorrectly from the final navigation mesh, or may delete the navigation mesh's polygons.
9899
</member>
99100
<member name="border_size" type="float" setter="set_border_size" getter="get_border_size" default="0.0">
100101
The size of the non-navigable border around the bake bounding area.
101102
In conjunction with the [member filter_baking_aabb] and a [member edge_max_error] value at [code]1.0[/code] or below the border size can be used to bake tile aligned navigation meshes without the tile edges being shrunk by [member agent_radius].
102-
[b]Note:[/b] While baking and not zero, this value will be rounded up to the nearest multiple of [member cell_size].
103+
[b]Note:[/b] While baking and not [code]0.0[/code], this value will be rounded up to the nearest multiple of [member cell_size].
103104
</member>
104105
<member name="cell_height" type="float" setter="set_cell_height" getter="get_cell_height" default="0.25">
105106
The cell height used to rasterize the navigation mesh vertices on the Y axis. Must match with the cell height on the navigation map.

doc/classes/NavigationPolygon.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,7 @@
172172
<members>
173173
<member name="agent_radius" type="float" setter="set_agent_radius" getter="get_agent_radius" default="10.0">
174174
The distance to erode/shrink the walkable surface when baking the navigation mesh.
175+
[b]Note:[/b] The radius must be positive. If the radius is [code]0.0[/code], it won't be possible to fix invalid outline overlaps and other precision errors during the baking process. As a result, some obstacles may be excluded incorrectly from the final navigation mesh, or may delete the navigation mesh's polygons.
175176
</member>
176177
<member name="baking_rect" type="Rect2" setter="set_baking_rect" getter="get_baking_rect" default="Rect2(0, 0, 0, 0)">
177178
If the baking [Rect2] has an area the navigation mesh baking will be restricted to its enclosing area.

0 commit comments

Comments
 (0)