diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index ee61453e741..c410fb80ee3 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -95,11 +95,12 @@ The distance to erode/shrink the walkable area of the heightfield away from obstructions. [b]Note:[/b] While baking, this value will be rounded up to the nearest multiple of [member cell_size]. + [b]Note:[/b] The radius must be equal or higher than [code]0.0[/code]. 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. The size of the non-navigable border around the bake bounding area. 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]. - [b]Note:[/b] While baking and not zero, this value will be rounded up to the nearest multiple of [member cell_size]. + [b]Note:[/b] If this value is not [code]0.0[/code], it will be rounded up to the nearest multiple of [member cell_size] during baking. The cell height used to rasterize the navigation mesh vertices on the Y axis. Must match with the cell height on the navigation map. diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml index 9eac989d191..2310bac8fb8 100644 --- a/doc/classes/NavigationPolygon.xml +++ b/doc/classes/NavigationPolygon.xml @@ -172,6 +172,7 @@ The distance to erode/shrink the walkable surface when baking the navigation mesh. + [b]Note:[/b] The radius must be equal or higher than [code]0.0[/code]. 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. If the baking [Rect2] has an area the navigation mesh baking will be restricted to its enclosing area.