Browse Source

Merge pull request #42974 from skyace65/NavMesh2

Document more NavigationMesh properties
Rémi Verschelde 4 years ago
parent
commit
cdafcc3206
1 changed files with 3 additions and 0 deletions
  1. 3 0
      doc/classes/NavigationMesh.xml

+ 3 - 0
doc/classes/NavigationMesh.xml

@@ -79,6 +79,7 @@
 	</methods>
 	<members>
 		<member name="agent/height" type="float" setter="set_agent_height" getter="get_agent_height" default="2.0">
+			The minimum Y space needed for navigation to be generated.
 		</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.
@@ -87,8 +88,10 @@
 			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">
+			Determines where the edge of a navigation mesh is. This way an agent will not overlap with another mesh or stand over nothing.
 		</member>
 		<member name="cell/height" type="float" setter="set_cell_height" getter="get_cell_height" default="0.2">
+			The height of a cell.
 		</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].