diff options
Diffstat (limited to 'doc/classes/NavigationAgent.xml')
| -rw-r--r-- | doc/classes/NavigationAgent.xml | 38 |
1 files changed, 20 insertions, 18 deletions
diff --git a/doc/classes/NavigationAgent.xml b/doc/classes/NavigationAgent.xml index d0e2a60fbf..f896bf6d15 100644 --- a/doc/classes/NavigationAgent.xml +++ b/doc/classes/NavigationAgent.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="NavigationAgent" inherits="Node" category="Core" version="3.2"> +<class name="NavigationAgent" inherits="Node" version="4.0"> <brief_description> 3D Agent used in navigation for collision avoidance. </brief_description> @@ -24,7 +24,7 @@ </description> </method> <method name="get_nav_path" qualifiers="const"> - <return type="PoolVector3Array"> + <return type="PackedVector3Array"> </return> <description> Returns the path from start to finish in global coordinates. @@ -34,7 +34,7 @@ <return type="int"> </return> <description> - Returns which index the agent is currently on in the navigation path's [PoolVector3Array]. + Returns which index the agent is currently on in the navigation path's [PackedVector3Array]. </description> </method> <method name="get_navigation" qualifiers="const"> @@ -108,32 +108,32 @@ </method> </methods> <members> - <member name="target_desired_distance" type="float" setter="set_target_desired_distance" getter="get_target_desired_distance" default="1.0"> - The distance threshold before a target is considered to be reached. This will allow an agent to not have to hit a point on the path exactly, but in the area. - </member> - <member name="radius" type="float" setter="set_radius" getter="get_radius" default="1.0"> - The radius of the agent. - </member> <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. </member> - <member name="neighbor_dist" type="float" setter="set_neighbor_dist" getter="get_neighbor_dist" default="50.0"> - The distance to search for other agents. + <member name="ignore_y" type="bool" setter="set_ignore_y" getter="get_ignore_y" default="true"> + Ignores collisions on the Y axis. Must be true to move on a horizontal plane. </member> <member name="max_neighbors" type="int" setter="set_max_neighbors" getter="get_max_neighbors" default="10"> The maximum number of neighbors for the agent to consider. </member> - <member name="time_horizon" type="float" setter="set_time_horizon" getter="get_time_horizon" default="5.0"> - The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithim, are safe with respect to other agents. The larger the number, the sooner the agent will respond to other agents, but less freedom in choosing its velocities. Must be positive. - </member> <member name="max_speed" type="float" setter="set_max_speed" getter="get_max_speed" default="10.0"> The maximum speed that an agent can move. </member> + <member name="neighbor_dist" type="float" setter="set_neighbor_dist" getter="get_neighbor_dist" default="50.0"> + The distance to search for other agents. + </member> <member name="path_max_distance" type="float" setter="set_path_max_distance" getter="get_path_max_distance" default="3.0"> The maximum distance the agent is allowed away from the ideal path to the final location. This can happen due to trying to avoid collisions. When the maximum distance is exceded, it recalculates the ideal path. </member> - <member name="ignore_y" type="bool" setter="set_ignore_y" getter="get_ignore_y" default="true"> - Ignores collisions on the Y axis. Must be true to move on a horizontal plane. + <member name="radius" type="float" setter="set_radius" getter="get_radius" default="1.0"> + The radius of the agent. + </member> + <member name="target_desired_distance" type="float" setter="set_target_desired_distance" getter="get_target_desired_distance" default="1.0"> + The distance threshold before a target is considered to be reached. This will allow an agent to not have to hit a point on the path exactly, but in the area. + </member> + <member name="time_horizon" type="float" setter="set_time_horizon" getter="get_time_horizon" default="5.0"> + The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithim, are safe with respect to other agents. The larger the number, the sooner the agent will respond to other agents, but less freedom in choosing its velocities. Must be positive. </member> </members> <signals> @@ -149,15 +149,17 @@ </signal> <signal name="target_reached"> <description> - Notifies when the player defined target, set with [method set_target_location], is reached. + Notifies when the player defined target, set with [method set_target_location], is reached. </description> </signal> <signal name="velocity_computed"> - <argument index="0" name="safe_velocity" type="Vector2"> + <argument index="0" name="safe_velocity" type="Vector3"> </argument> <description> Notifies when the collision avoidance velocity is calculated. Emitted by [method set_velocity]. </description> </signal> </signals> + <constants> + </constants> </class> |