浏览代码

Document that NavigationAgent height offset is mostly a placebo

Document that NavigationAgent height offset is mostly a placebo.

(cherry picked from commit b1d98534154dafa208076e8f8d7c93e4a43726f9)
smix8 3 年之前
父节点
当前提交
c9c5e57109
共有 1 个文件被更改,包括 1 次插入1 次删除
  1. 1 1
      doc/classes/NavigationAgent.xml

+ 1 - 1
doc/classes/NavigationAgent.xml

@@ -99,7 +99,7 @@
 	</methods>
 	<members>
 		<member name="agent_height_offset" type="float" setter="set_agent_height_offset" getter="get_agent_height_offset" default="0.0">
-			The agent height offset to match the navigation mesh height.
+			The NavigationAgent height offset is subtracted from the y-axis value of any vector path position for this NavigationAgent. The NavigationAgent height offset does not change or influence the navigation mesh or pathfinding query result. Additional navigation maps that use regions with navigation meshes that the developer baked with appropriate agent radius or height values are required to support different-sized agents.
 		</member>
 		<member name="avoidance_enabled" type="bool" setter="set_avoidance_enabled" getter="get_avoidance_enabled" default="false">
 			If [code]true[/code] the agent is registered for an RVO avoidance callback on the [NavigationServer]. When [method set_velocity] is used and the processing is completed a [code]safe_velocity[/code] Vector3 is received with a signal connection to [signal velocity_computed]. Avoidance processing with many registered agents has a significant performance cost and should only be enabled on agents that currently require it.