Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

NavigationAgent2D¶

Inherits: Node < Object

A 2D agent used to pathfind to a position while avoiding obstacles.

Description¶

A 2D agent used to pathfind to a position while avoiding static and dynamic obstacles. The calculation can be used by the parent node to dynamically move it along the path. Requires navigation data to work correctly.

Dynamic obstacles are avoided using RVO collision avoidance. Avoidance is computed before physics, so the pathfinding information can be used safely in the physics step.

Note: After setting the target_position property, the get_next_path_position method must be used once every physics frame to update the internal path logic of the navigation agent. The vector position it returns should be used as the next movement position for the agent's parent node.

Tutorials¶

Using NavigationAgents

Properties¶

bool	avoidance_enabled	`false`
int	avoidance_layers	`1`
int	avoidance_mask	`1`
float	avoidance_priority	`1.0`
bool	debug_enabled	`false`
Color	debug_path_custom_color	`Color(1, 1, 1, 1)`
float	debug_path_custom_line_width	`-1.0`
float	debug_path_custom_point_size	`4.0`
bool	debug_use_custom	`false`
int	max_neighbors	`10`
float	max_speed	`100.0`
int	navigation_layers	`1`
float	neighbor_distance	`500.0`
float	path_desired_distance	`20.0`
float	path_max_distance	`100.0`
PathMetadataFlags	path_metadata_flags	`7`
PathPostProcessing	path_postprocessing	`0`
PathfindingAlgorithm	pathfinding_algorithm	`0`
float	radius	`10.0`
float	target_desired_distance	`10.0`
Vector2	target_position	`Vector2(0, 0)`
float	time_horizon_agents	`1.0`
float	time_horizon_obstacles	`0.0`
Vector2	velocity	`Vector2(0, 0)`

Methods¶

float	distance_to_target ( ) const
bool	get_avoidance_layer_value ( int layer_number ) const
bool	get_avoidance_mask_value ( int mask_number ) const
PackedVector2Array	get_current_navigation_path ( ) const
int	get_current_navigation_path_index ( ) const
NavigationPathQueryResult2D	get_current_navigation_result ( ) const
Vector2	get_final_position ( )
bool	get_navigation_layer_value ( int layer_number ) const
RID	get_navigation_map ( ) const
Vector2	get_next_path_position ( )
RID	get_rid ( ) const
bool	is_navigation_finished ( )
bool	is_target_reachable ( )
bool	is_target_reached ( ) const
void	set_avoidance_layer_value ( int layer_number, bool value )
void	set_avoidance_mask_value ( int mask_number, bool value )
void	set_navigation_layer_value ( int layer_number, bool value )
void	set_navigation_map ( RID navigation_map )
void	set_velocity_forced ( Vector2 velocity )

Signals¶

link_reached ( Dictionary details )

Notifies when a navigation link has been reached.

The details dictionary may contain the following keys depending on the value of path_metadata_flags:

position: The start position of the link that was reached.
type: Always NavigationPathQueryResult2D.PATH_SEGMENT_TYPE_LINK.
rid: The RID of the link.
owner: The object which manages the link (usually NavigationLink2D).
link_entry_position: If owner is available and the owner is a NavigationLink2D, it will contain the global position of the link's point the agent is entering.
link_exit_position: If owner is available and the owner is a NavigationLink2D, it will contain the global position of the link's point which the agent is exiting.

Notifies when the final position is reached.

path_changed ( )

Notifies when the navigation path changes.

target_reached ( )

Notifies when the player-defined target_position is reached.

velocity_computed ( Vector2 safe_velocity )

Notifies when the collision avoidance velocity is calculated. Emitted when velocity is set. Only emitted when avoidance_enabled is true.

waypoint_reached ( Dictionary details )

Notifies when a waypoint along the path has been reached.

The details dictionary may contain the following keys depending on the value of path_metadata_flags:

position: The position of the waypoint that was reached.
type: The type of navigation primitive (region or link) that contains this waypoint.
rid: The RID of the containing navigation primitive (region or link).
owner: The object which manages the containing navigation primitive (region or link).

Property Descriptions¶

bool avoidance_enabled = false

void set_avoidance_enabled ( bool value )
bool get_avoidance_enabled ( )

If true the agent is registered for an RVO avoidance callback on the NavigationServer2D. When velocity is used and the processing is completed a safe_velocity Vector2 is received with a signal connection to velocity_computed. Avoidance processing with many registered agents has a significant performance cost and should only be enabled on agents that currently require it.

int avoidance_layers = 1

void set_avoidance_layers ( int value )
int get_avoidance_layers ( )

A bitfield determining the avoidance layers for this NavigationAgent. Other agent's with a matching bit on the avoidance_mask will avoid this agent.

int avoidance_mask = 1

void set_avoidance_mask ( int value )
int get_avoidance_mask ( )

A bitfield determining what other avoidance agent's and obstacles this NavigationAgent will avoid when a bit matches at least one of their avoidance_layers.

float avoidance_priority = 1.0

void set_avoidance_priority ( float value )
float get_avoidance_priority ( )

The agent does not adjust the velocity for other agents that would match the avoidance_mask but have a lower avoidance_priority. This in turn makes the other agents with lower priority adjust their velocities even more to avoid collision with this agent.

bool debug_enabled = false

void set_debug_enabled ( bool value )
bool get_debug_enabled ( )

If true shows debug visuals for this agent.

Color debug_path_custom_color = Color(1, 1, 1, 1)

void set_debug_path_custom_color ( Color value )
Color get_debug_path_custom_color ( )

If debug_use_custom is true uses this color for this agent instead of global color.

float debug_path_custom_line_width = -1.0

void set_debug_path_custom_line_width ( float value )
float get_debug_path_custom_line_width ( )

If debug_use_custom is true uses this line width for rendering paths for this agent instead of global line width.

float debug_path_custom_point_size = 4.0

void set_debug_path_custom_point_size ( float value )
float get_debug_path_custom_point_size ( )

If debug_use_custom is true uses this rasterized point size for rendering path points for this agent instead of global point size.

bool debug_use_custom = false

void set_debug_use_custom ( bool value )
bool get_debug_use_custom ( )

If true uses the defined debug_path_custom_color for this agent instead of global color.

int max_neighbors = 10

void set_max_neighbors ( int value )
int get_max_neighbors ( )

The maximum number of neighbors for the agent to consider.

float max_speed = 100.0

void set_max_speed ( float value )
float get_max_speed ( )

The maximum speed that an agent can move.

int navigation_layers = 1

void set_navigation_layers ( int value )
int get_navigation_layers ( )

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.

float neighbor_distance = 500.0

void set_neighbor_distance ( float value )
float get_neighbor_distance ( )

The distance to search for other agents.

float path_desired_distance = 20.0

void set_path_desired_distance ( float value )
float get_path_desired_distance ( )

The distance threshold before a path point is considered to be reached. This will allow an agent to not have to hit a path po