212 lines
14 KiB
XML
212 lines
14 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="NavigationAgent2D" inherits="Node" is_experimental="true" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
2D Agent used in navigation for collision avoidance.
|
|
</brief_description>
|
|
<description>
|
|
2D Agent that is used in navigation to reach a position while avoiding static and dynamic obstacles. The dynamic obstacles are avoided using RVO collision avoidance. The agent needs navigation data to work correctly. [NavigationAgent2D] is physics safe.
|
|
[b]Note:[/b] After setting [member target_position] it is required to use the [method get_next_path_position] function once every physics frame to update the internal path logic of the NavigationAgent. The returned vector position from this function should be used as the next movement position for the agent's parent Node.
|
|
</description>
|
|
<tutorials>
|
|
<link title="Using NavigationAgents">$DOCS_URL/tutorials/navigation/navigation_using_navigationagents.html</link>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="distance_to_target" qualifiers="const">
|
|
<return type="float" />
|
|
<description>
|
|
Returns the distance to the target position, using the agent's global position. The user must set [member target_position] in order for this to be accurate.
|
|
</description>
|
|
</method>
|
|
<method name="get_current_navigation_path" qualifiers="const">
|
|
<return type="PackedVector2Array" />
|
|
<description>
|
|
Returns this agent's current path from start to finish in global coordinates. The path only updates when the target position is changed or the agent requires a repath. The path array is not intended to be used in direct path movement as the agent has its own internal path logic that would get corrupted by changing the path array manually. Use the intended [method get_next_path_position] once every physics frame to receive the next path point for the agents movement as this function also updates the internal path logic.
|
|
</description>
|
|
</method>
|
|
<method name="get_current_navigation_path_index" qualifiers="const">
|
|
<return type="int" />
|
|
<description>
|
|
Returns which index the agent is currently on in the navigation path's [PackedVector2Array].
|
|
</description>
|
|
</method>
|
|
<method name="get_current_navigation_result" qualifiers="const">
|
|
<return type="NavigationPathQueryResult2D" />
|
|
<description>
|
|
Returns the path query result for the path the agent is currently following.
|
|
</description>
|
|
</method>
|
|
<method name="get_final_position">
|
|
<return type="Vector2" />
|
|
<description>
|
|
Returns the reachable final position in global coordinates. This can change if the navigation path is altered in any way. Because of this, it would be best to check this each frame.
|
|
</description>
|
|
</method>
|
|
<method name="get_navigation_layer_value" qualifiers="const">
|
|
<return type="bool" />
|
|
<param index="0" name="layer_number" type="int" />
|
|
<description>
|
|
Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [param layer_number] between 1 and 32.
|
|
</description>
|
|
</method>
|
|
<method name="get_navigation_map" qualifiers="const">
|
|
<return type="RID" />
|
|
<description>
|
|
Returns the [RID] of the navigation map for this NavigationAgent node. This function returns always the map set on the NavigationAgent node and not the map of the abstract agent on the NavigationServer. If the agent map is changed directly with the NavigationServer API the NavigationAgent node will not be aware of the map change. Use [method set_navigation_map] to change the navigation map for the NavigationAgent and also update the agent on the NavigationServer.
|
|
</description>
|
|
</method>
|
|
<method name="get_next_path_position">
|
|
<return type="Vector2" />
|
|
<description>
|
|
Returns the next position in global coordinates that can be moved to, making sure that there are no static objects in the way. If the agent does not have a navigation path, it will return the position of the agent's parent. The use of this function once every physics frame is required to update the internal path logic of the NavigationAgent.
|
|
</description>
|
|
</method>
|
|
<method name="get_rid" qualifiers="const">
|
|
<return type="RID" />
|
|
<description>
|
|
Returns the [RID] of this agent on the [NavigationServer2D].
|
|
</description>
|
|
</method>
|
|
<method name="is_navigation_finished">
|
|
<return type="bool" />
|
|
<description>
|
|
Returns true if the navigation path's final position has been reached.
|
|
</description>
|
|
</method>
|
|
<method name="is_target_reachable">
|
|
<return type="bool" />
|
|
<description>
|
|
Returns true if [member target_position] is reachable.
|
|
</description>
|
|
</method>
|
|
<method name="is_target_reached" qualifiers="const">
|
|
<return type="bool" />
|
|
<description>
|
|
Returns true if [member target_position] is reached. It may not always be possible to reach the target position. It should always be possible to reach the final position though. See [method get_final_position].
|
|
</description>
|
|
</method>
|
|
<method name="set_navigation_layer_value">
|
|
<return type="void" />
|
|
<param index="0" name="layer_number" type="int" />
|
|
<param index="1" name="value" type="bool" />
|
|
<description>
|
|
Based on [param value], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [param layer_number] between 1 and 32.
|
|
</description>
|
|
</method>
|
|
<method name="set_navigation_map">
|
|
<return type="void" />
|
|
<param index="0" name="navigation_map" type="RID" />
|
|
<description>
|
|
Sets the [RID] of the navigation map this NavigationAgent node should use and also updates the [code]agent[/code] on the NavigationServer.
|
|
</description>
|
|
</method>
|
|
<method name="set_velocity">
|
|
<return type="void" />
|
|
<param index="0" name="velocity" type="Vector2" />
|
|
<description>
|
|
Sends the passed in velocity to the collision avoidance algorithm. It will adjust the velocity to avoid collisions. Once the adjustment to the velocity is complete, it will emit the [signal velocity_computed] signal.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<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 [NavigationServer2D]. When [method NavigationAgent2D.set_velocity] is used and the processing is completed a [code]safe_velocity[/code] Vector2 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.
|
|
</member>
|
|
<member name="debug_enabled" type="bool" setter="set_debug_enabled" getter="get_debug_enabled" default="false">
|
|
If [code]true[/code] shows debug visuals for this agent.
|
|
</member>
|
|
<member name="debug_path_custom_color" type="Color" setter="set_debug_path_custom_color" getter="get_debug_path_custom_color" default="Color(1, 1, 1, 1)">
|
|
If [member debug_use_custom] is [code]true[/code] uses this color for this agent instead of global color.
|
|
</member>
|
|
<member name="debug_path_custom_line_width" type="float" setter="set_debug_path_custom_line_width" getter="get_debug_path_custom_line_width" default="-1.0">
|
|
If [member debug_use_custom] is [code]true[/code] uses this line width for rendering paths for this agent instead of global line width.
|
|
</member>
|
|
<member name="debug_path_custom_point_size" type="float" setter="set_debug_path_custom_point_size" getter="get_debug_path_custom_point_size" default="4.0">
|
|
If [member debug_use_custom] is [code]true[/code] uses this rasterized point size for rendering path points for this agent instead of global point size.
|
|
</member>
|
|
<member name="debug_use_custom" type="bool" setter="set_debug_use_custom" getter="get_debug_use_custom" default="false">
|
|
If [code]true[/code] uses the defined [member debug_path_custom_color] for this agent instead of global color.
|
|
</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="max_speed" type="float" setter="set_max_speed" getter="get_max_speed" default="100.0">
|
|
The maximum speed that an agent can move.
|
|
</member>
|
|
<member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1">
|
|
A bitfield determining what navigation layers of navigation regions this agent will use to calculate path. Changing it runtime will clear current navigation path and generate new one, according to new navigation layers.
|
|
</member>
|
|
<member name="neighbor_distance" type="float" setter="set_neighbor_distance" getter="get_neighbor_distance" default="500.0">
|
|
The distance to search for other agents.
|
|
</member>
|
|
<member name="path_desired_distance" type="float" setter="set_path_desired_distance" getter="get_path_desired_distance" default="20.0">
|
|
The distance threshold before a path point is considered to be reached. This will allow an agent to not have to hit a path point on the path exactly, but in the area. If this value is set to high the NavigationAgent will skip points on the path which can lead to leaving the navigation mesh. If this value is set to low the NavigationAgent will be stuck in a repath loop cause it will constantly overshoot or undershoot the distance to the next point on each physics frame update.
|
|
</member>
|
|
<member name="path_max_distance" type="float" setter="set_path_max_distance" getter="get_path_max_distance" default="100.0">
|
|
The maximum distance the agent is allowed away from the ideal path to the final position. This can happen due to trying to avoid collisions. When the maximum distance is exceeded, it recalculates the ideal path.
|
|
</member>
|
|
<member name="path_metadata_flags" type="int" setter="set_path_metadata_flags" getter="get_path_metadata_flags" enum="NavigationPathQueryParameters2D.PathMetadataFlags" default="7">
|
|
Additional information to return with the navigation path.
|
|
</member>
|
|
<member name="radius" type="float" setter="set_radius" getter="get_radius" default="10.0">
|
|
The radius of the avoidance agent. This is the "body" of the avoidance agent and not the avoidance maneuver starting radius (which is controlled by [member neighbor_distance]).
|
|
Does not affect normal pathfinding. To change an actor's pathfinding radius bake [NavigationMesh] resources with a different [member NavigationMesh.agent_radius] property and use different navigation maps for each actor size.
|
|
</member>
|
|
<member name="target_desired_distance" type="float" setter="set_target_desired_distance" getter="get_target_desired_distance" default="10.0">
|
|
The distance threshold before the final target point is considered to be reached. This will allow an agent to not have to hit the point of the final target exactly, but only the area. If this value is set to low the NavigationAgent will be stuck in a repath loop cause it will constantly overshoot or undershoot the distance to the final target point on each physics frame update.
|
|
</member>
|
|
<member name="target_position" type="Vector2" setter="set_target_position" getter="get_target_position" default="Vector2(0, 0)">
|
|
The user-defined target position. Setting this property will clear the current navigation path.
|
|
</member>
|
|
<member name="time_horizon" type="float" setter="set_time_horizon" getter="get_time_horizon" default="1.0">
|
|
The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithm, 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>
|
|
<signal name="link_reached">
|
|
<param index="0" name="details" type="Dictionary" />
|
|
<description>
|
|
Notifies when a navigation link has been reached.
|
|
The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]:
|
|
- [code]position[/code]: The start position of the link that was reached.
|
|
- [code]type[/code]: Always [constant NavigationPathQueryResult2D.PATH_SEGMENT_TYPE_LINK].
|
|
- [code]rid[/code]: The [RID] of the link.
|
|
- [code]owner[/code]: The object which manages the link (usually [NavigationLink2D]).
|
|
- [code]link_entry_position[/code]: If [code]owner[/code] is available and the owner is a [NavigationLink2D], it will contain the global position of the link's point the agent is entering.
|
|
- [code]link_exit_position[/code]: If [code]owner[/code] is available and the owner is a [NavigationLink2D], it will contain the global position of the link's point which the agent is exiting.
|
|
</description>
|
|
</signal>
|
|
<signal name="navigation_finished">
|
|
<description>
|
|
Notifies when the final position is reached.
|
|
</description>
|
|
</signal>
|
|
<signal name="path_changed">
|
|
<description>
|
|
Notifies when the navigation path changes.
|
|
</description>
|
|
</signal>
|
|
<signal name="target_reached">
|
|
<description>
|
|
Notifies when the player-defined [member target_position] is reached.
|
|
</description>
|
|
</signal>
|
|
<signal name="velocity_computed">
|
|
<param index="0" name="safe_velocity" type="Vector2" />
|
|
<description>
|
|
Notifies when the collision avoidance velocity is calculated. Emitted by [method set_velocity]. Only emitted when [member avoidance_enabled] is true.
|
|
</description>
|
|
</signal>
|
|
<signal name="waypoint_reached">
|
|
<param index="0" name="details" type="Dictionary" />
|
|
<description>
|
|
Notifies when a waypoint along the path has been reached.
|
|
The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]:
|
|
- [code]position[/code]: The position of the waypoint that was reached.
|
|
- [code]type[/code]: The type of navigation primitive (region or link) that contains this waypoint.
|
|
- [code]rid[/code]: The [RID] of the containing navigation primitive (region or link).
|
|
- [code]owner[/code]: The object which manages the containing navigation primitive (region or link).
|
|
</description>
|
|
</signal>
|
|
</signals>
|
|
</class>
|