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
BitField<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 )