From 496a2f17bd8c30b2d28273d71ce2eedba1953c9f Mon Sep 17 00:00:00 2001
From: skyace65 <trekie96@hotmail.com>
Date: Wed, 9 Sep 2020 10:21:18 -0400
Subject: [PATCH] Document some properties of NavigationMesh

---
 doc/classes/NavigationMesh.xml | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml
index 6deca4394f2..a2fa31bf65e 100644
--- a/doc/classes/NavigationMesh.xml
+++ b/doc/classes/NavigationMesh.xml
@@ -80,14 +80,17 @@
 		<member name="agent/height" type="float" setter="set_agent_height" getter="get_agent_height" default="2.0">
 		</member>
 		<member name="agent/max_climb" type="float" setter="set_agent_max_climb" getter="get_agent_max_climb" default="0.9">
+			The maximum height difference between two areas for navigation to be generated between them.
 		</member>
 		<member name="agent/max_slope" type="float" setter="set_agent_max_slope" getter="get_agent_max_slope" default="45.0">
+			The maximum angle a slope can be at for navigation to be generated on it.
 		</member>
 		<member name="agent/radius" type="float" setter="set_agent_radius" getter="get_agent_radius" default="0.6">
 		</member>
 		<member name="cell/height" type="float" setter="set_cell_height" getter="get_cell_height" default="0.2">
 		</member>
 		<member name="cell/size" type="float" setter="set_cell_size" getter="get_cell_size" default="0.3">
+			The size of cells in the [NavigationMesh].
 		</member>
 		<member name="detail/sample_distance" type="float" setter="set_detail_sample_distance" getter="get_detail_sample_distance" default="6.0">
 		</member>
@@ -104,18 +107,25 @@
 		<member name="filter/low_hanging_obstacles" type="bool" setter="set_filter_low_hanging_obstacles" getter="get_filter_low_hanging_obstacles" default="false">
 		</member>
 		<member name="geometry/collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask">
+			The physics layers used to generate the [NavigationMesh].
 		</member>
 		<member name="geometry/parsed_geometry_type" type="int" setter="set_parsed_geometry_type" getter="get_parsed_geometry_type" default="0">
+			What kind of geomerty is used to generate the [NavigationMesh].
 		</member>
 		<member name="geometry/source_geometry_mode" type="int" setter="set_source_geometry_mode" getter="get_source_geometry_mode" default="0">
+			Which geometry is used to generate the [NavigationMesh].
 		</member>
 		<member name="geometry/source_group_name" type="StringName" setter="set_source_group_name" getter="get_source_group_name">
+			The name of the group that is used to generate the [NavigationMesh].
 		</member>
 		<member name="polygon/verts_per_poly" type="float" setter="set_verts_per_poly" getter="get_verts_per_poly" default="6.0">
+			The number of vertices to use per polygon. Higher values will improve performance at the cost of lower precision.
 		</member>
 		<member name="region/merge_size" type="float" setter="set_region_merge_size" getter="get_region_merge_size" default="20.0">
+			If two adjacent regions' edges are separated by a distance lower than this value, the regions will be merged together.
 		</member>
 		<member name="region/min_size" type="float" setter="set_region_min_size" getter="get_region_min_size" default="8.0">
+			The minimum size of a region for it to be created.
 		</member>
 		<member name="sample_partition_type/sample_partition_type" type="int" setter="set_sample_partition_type" getter="get_sample_partition_type" default="0">
 		</member>