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

Experimental: This class may be changed or removed in future versions.

Hereda: Node < Object

Un agente 2D utilizado para encontrar el camino hacia una posición evitando obstáculos.

Descripción

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.

Note: Several methods of this class, such as get_next_path_position(), can trigger a new path calculation. Calling these in your callback to an agent's signal, such as waypoint_reached, can cause infinite recursion. It is recommended to call these methods in the physics step or, alternatively, delay their call until the end of the frame (see Object.call_deferred() or Object.CONNECT_DEFERRED).

Tutoriales

• Utilizando NavigationAgents

Propiedades

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
float	path_return_max_length	0.0
float	path_return_max_radius	0.0
float	path_search_max_distance	0.0
int	path_search_max_polygons	4096
PathfindingAlgorithm	pathfinding_algorithm	0
float	radius	10.0
float	simplify_epsilon	0.0
bool	simplify_path	false
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)

Métodos

float	distance_to_target() const
bool	get_avoidance_layer_value(layer_number: int) const
bool	get_avoidance_mask_value(mask_number: int) 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(layer_number: int) const
RID	get_navigation_map() const
Vector2	get_next_path_position()
float	get_path_length() const
RID	get_rid() const
bool	is_navigation_finished()
bool	is_target_reachable()
bool	is_target_reached() const
void	set_avoidance_layer_value(layer_number: int, value: bool)
void	set_avoidance_mask_value(mask_number: int, value: bool)
void	set_navigation_layer_value(layer_number: int, value: bool)
void	set_navigation_map(navigation_map: RID)
void	set_velocity_forced(velocity: Vector2)

---

Señales

link_reached(details: Dictionary) 🔗

Señala que el agente alcanzó un enlace de navegación. Se emite cuando el agente se mueve dentro de path_desired_distance de la siguiente posición del trayecto cuando esa posición es un enlace de navegación.

El diccionario de detalles puede contener las siguientes claves dependiendo del valor de path_metadata_flags:

• position: La posición inicial del enlace que se alcanzó.

• type: Siempre NavigationPathQueryResult2D.PATH_SEGMENT_TYPE_LINK.

• rid: El RID del enlace.

• owner: El objeto que gestiona el enlace (normalmente NavigationLink2D).

• link_entry_position: Si owner está disponible y el propietario es un NavigationLink2D, contendrá la posición global del punto del enlace al que entra el agente.

• link_exit_position: Si owner está disponible y el propietario es un NavigationLink2D, contendrá la posición global del punto del enlace por el que sale el agente.

---

navigation_finished() 🔗

Señala que la navegación del agente ha terminado. Si el objetivo es alcanzable, la navegación termina cuando se alcanza el objetivo. Si el objetivo es inalcanzable, la navegación termina cuando se alcanza el último punto de trayecto de la trayectoria. Esta señal se emite solo una vez por trayectoria cargada.

Esta señal se emitirá justo después de target_reached cuando el objetivo sea alcanzable.

---

path_changed() 🔗

Se emite cuando el agente tuvo que actualizar la trayectoria cargada:

• porque la trayectoria estaba previamente vacía.

• porque el mapa de navegación ha cambiado.

• porque el agente se alejó más del segmento de trayectoria actual de lo que permite path_max_distance.

---

target_reached() 🔗

Señala que el agente alcanzó el objetivo, es decir, el agente se movió dentro de target_desired_distance de la target_position. Esta señal se emite solo una vez por trayectoria cargada.

Esta señal se emitirá justo antes de navigation_finished cuando el objetivo sea alcanzable.

Puede que no siempre sea posible alcanzar el objetivo, pero siempre debería ser posible alcanzar la posición final. Véase get_final_position().

---

velocity_computed(safe_velocity: Vector2) 🔗

Notifica cuando se calcula la velocidad de evitación de colisiones. Se emite en cada actualización siempre que avoidance_enabled sea true y el agente tenga un mapa de navegación.

---

waypoint_reached(details: Dictionary) 🔗

Señala que el agente alcanzó un punto de trayecto. Se emite cuando el agente se mueve dentro de path_desired_distance de la siguiente posición del trayecto.

El diccionario de detalles puede contener las siguientes claves dependiendo del valor de path_metadata_flags:

• position: La posición del punto de trayecto que se alcanzó.

• type: El tipo de primitiva de navegación (región o enlace) que contiene este punto de trayecto.

• rid: El RID de la primitiva de navegación contenedora (región o enlace).

• owner: El objeto que gestiona la primitiva de navegación contenedora (región o enlace).

---

Descripciones de Propiedades

bool avoidance_enabled = false 🔗

• void set_avoidance_enabled(value: bool)

• 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(value: int)

• int get_avoidance_layers()

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

---

int avoidance_mask = 1 🔗

• void set_avoidance_mask(value: int)

• int get_avoidance_mask()

A bitfield determining what other avoidance agents 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(value: float)

• 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(value: bool)

• 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(value: Color)

• 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(value: float)

• 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(value: float)

• 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(value: bool)

• 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(value: int)

• int get_max_neighbors()

The maximum number of neighbors for the agent to consider.

---

float max_speed = 100.0 🔗

• void set_max_speed(value: float)

• float get_max_speed()

La velocidad máxima a la que un agente se puede mover.

---

int navigation_layers = 1 🔗

• void set_navigation_layers(value: int)

• int get_navigation_layers()

A bitfield determining which navigation layers of navigation regions this agent will use to calculate a path. Changing it during runtime will clear the current navigation path and generate a new one, according to the new navigation layers.

---

float neighbor_distance = 500.0 🔗

• void set_neighbor_distance(value: float)

• float get_neighbor_distance()

La distancia para buscar otros agentes.

---

float path_desired_distance = 20.0 🔗

• void set_path_desired_distance(value: float)

• float get_path_desired_distance()

The distance threshold before a path point is considered to be reached. This allows agents to not have to hit a path point on the path exactly, but only to reach its general area. If this value is set too high, the NavigationAgent will skip points on the path, which can lead to it leaving the navigation mesh. If this value is set too low, the NavigationAgent will be stuck in a repath loop because it will constantly overshoot the distance to the next point on each physics frame update.

---

float path_max_distance = 100.0 🔗

• void set_path_max_distance(value: float)

• float get_path_max_distance()

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.

---

BitField[PathMetadataFlags] path_metadata_flags = 7 🔗

• void set_path_metadata_flags(value: BitField[PathMetadataFlags])

• BitField[PathMetadataFlags] get_path_metadata_flags()

Additional information to return with the navigation path.

---

PathPostProcessing path_postprocessing = 0 🔗

• void set_path_postprocessing(value: PathPostProcessing)

• PathPostProcessing get_path_postprocessing()

The path postprocessing applied to the raw path corridor found by the pathfinding_algorithm.

---

float path_return_max_length = 0.0 🔗

• void set_path_return_max_length(value: float)

• float get_path_return_max_length()

The maximum allowed length of the returned path in world units. A path will be clipped when going over this length.

---

float path_return_max_radius = 0.0 🔗

• void set_path_return_max_radius(value: float)

• float get_path_return_max_radius()

The maximum allowed radius in world units that the returned path can be from the path start. The path will be clipped when going over this radius. Compared to path_return_max_length, this allows the agent to go that much further, if they need to walk around a corner.

Note: This will perform a sphere clip considering only the actual navigation mesh path points with the first path position being the sphere's center.

---

float path_search_max_distance = 0.0 🔗

• void set_path_search_max_distance(value: float)

• float get_path_search_max_distance()

The maximum distance a searched polygon can be away from the start polygon before the pathfinding cancels the search for a path to the (possibly unreachable or very far away) target position polygon. In this case the pathfinding resets and builds a path from the start polygon to the polygon that was found closest to the target position so far. A value of 0 or below counts as unlimited. In case of unlimited the pathfinding will search all polygons connected with the start polygon until either the target position polygon is found or all available polygon search options are exhausted.

---

int path_search_max_polygons = 4096 🔗

• void set_path_search_max_polygons(value: int)

• int get_path_search_max_polygons()

The maximum number of polygons that are searched before the pathfinding cancels the search for a path to the (possibly unreachable or very far away) target position polygon. In this case the pathfinding resets and builds a path from the start polygon to the polygon that was found closest to the target position so far. A value of 0 or below counts as unlimited. In case of unlimited the pathfinding will search all polygons connected with the start polygon until either the target position polygon is found or all available polygon search options are exhausted.

---

PathfindingAlgorithm pathfinding_algorithm = 0 🔗

• void set_pathfinding_algorithm(value: PathfindingAlgorithm)

• PathfindingAlgorithm get_pathfinding_algorithm()

The pathfinding algorithm used in the path query.

---

float radius = 10.0 🔗

• void set_radius(value: float)

• float get_radius()

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 neighbor_distance).

Does not affect normal pathfinding. To change an actor's pathfinding radius bake NavigationPolygon resources with a different NavigationPolygon.agent_radius property and use different navigation maps for each actor size.

---

float simplify_epsilon = 0.0 🔗

• void set_simplify_epsilon(value: float)

• float get_simplify_epsilon()

The path simplification amount in worlds units.

---

bool simplify_path = false 🔗

• void set_simplify_path(value: bool)

• bool get_simplify_path()

Si es true, se devolverá una versión simplificada del trayecto con menos puntos críticos de trayectos eliminados. La cantidad de simplificación se controla mediante simplify_epsilon. La simplificación utiliza una variante del algoritmo Ramer-Douglas-Peucker para la diezma de puntos de curva.

La simplificación de trayectos puede ser útil para mitigar varios problemas de seguimiento de trayectos que pueden surgir con ciertos tipos de agentes y comportamientos de script. Por ejemplo, agentes de "dirección" o evitación en "campos abiertos".

---

float target_desired_distance = 10.0 🔗

• void set_target_desired_distance(value: float)

• float get_target_desired_distance()

El umbral de distancia antes de que se considere alcanzado el objetivo. Al alcanzar el objetivo, se emite target_reached y la navegación termina (véase is_navigation_finished() y navigation_finished).

Puedes hacer que la navegación termine antes estableciendo esta propiedad a un valor mayor que path_desired_distance (la navegación terminará antes de alcanzar el último punto de paso).

También puedes hacer que la navegación termine más cerca del objetivo que cada posición de trayecto individual estableciendo esta propiedad a un valor menor que path_desired_distance (la navegación no terminará inmediatamente al alcanzar el último punto de paso). Sin embargo, si el valor establecido es demasiado bajo, el agente se quedará atascado en un bucle de repath porque constantemente superará la distancia al objetivo en cada actualización del frame de física.

---

Vector2 target_position = Vector2(0, 0) 🔗

• void set_target_position(value: Vector2)

• Vector2 get_target_position()

Si se establece, se solicita un nuevo camino de navegación desde la posición actual del agente hasta la target_position al NavigationServer.

---

float time_horizon_agents = 1.0 🔗

• void set_time_horizon_agents(value: float)

• float get_time_horizon_agents()

La cantidad mínima de tiempo durante la cual las velocidades de este agente, que se calculan con el algoritmo de evitación de colisiones, son seguras con respecto a otros agentes. Cuanto mayor sea el número, antes responderá el agente a otros agentes, pero tendrá menos libertad para elegir sus velocidades. Un valor demasiado alto ralentizará considerablemente el movimiento de los agentes. Debe ser positivo.

---

float time_horizon_obstacles = 0.0 🔗

• void set_time_horizon_obstacles(value: float)

• float get_time_horizon_obstacles()

La cantidad mínima de tiempo durante la cual las velocidades de este agente, calculadas con el algoritmo de evitación de colisiones, son seguras con respecto a los obstáculos de evitación estáticos. Cuanto mayor sea el número, antes responderá el agente a los obstáculos de evitación estáticos, pero tendrá menos libertad para elegir sus velocidades. Un valor demasiado alto ralentizará considerablemente el movimiento de los agentes. Debe ser positivo.

---

Vector2 velocity = Vector2(0, 0) 🔗

• void set_velocity(value: Vector2)

• Vector2 get_velocity()

Establece la nueva velocidad deseada para el agente. La simulación de evitación intentará cumplir esta velocidad si es posible, pero la modificará para evitar colisiones con otros agentes y obstáculos. Cuando un agente es teletransportado a una nueva posición, usa también set_velocity_forced() para restablecer la velocidad de simulación interna.

---

Descripciones de Métodos

float distance_to_target() const 🔗

Devuelve la distancia a la posición objetivo, utilizando la posición global del agente. El usuario debe configurar target_position para que sea precisa.

---

bool get_avoidance_layer_value(layer_number: int) const 🔗

Returns whether or not the specified layer of the avoidance_layers bitmask is enabled, given a layer_number between 1 and 32.

---

bool get_avoidance_mask_value(mask_number: int) const 🔗

Returns whether or not the specified mask of the avoidance_mask bitmask is enabled, given a mask_number between 1 and 32.

---

PackedVector2Array get_current_navigation_path() const 🔗

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 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.

---

int get_current_navigation_path_index() const 🔗

Devuelve el índice en el que se encuentra actualmente el agente en el PackedVector2Array de la ruta de navegación.

---

NavigationPathQueryResult2D get_current_navigation_result() const 🔗

Devuelve el resultado de la consulta de la ruta que el agente está siguiendo actualmente.

---

Vector2 get_final_position() 🔗

Devuelve la posición final alcanzable de la ruta de navegación actual en coordenadas globales. Esta posición puede cambiar si el agente necesita actualizar la ruta de navegación, lo que hace que el agente emita la señal path_changed.

---

bool get_navigation_layer_value(layer_number: int) const 🔗

Devuelve si la capa especificada de la máscara de bits navigation_layers está habilitada, dado un layer_number entre 1 y 32.

---

RID get_navigation_map() const 🔗

Devuelve el RID del mapa de navegación para este nodo NavigationAgent. Esta función siempre devuelve el mapa establecido en el nodo NavigationAgent y no el mapa del agente abstracto en el NavigationServer. Si el mapa del agente se cambia directamente con la API de NavigationServer, el nodo NavigationAgent no estará al tanto del cambio de mapa. Utiliza set_navigation_map() para cambiar el mapa de navegación para NavigationAgent y también actualizar el agente en el NavigationServer.

---

Vector2 get_next_path_position() 🔗

Devuelve la siguiente posición en coordenadas globales a la que se puede mover, asegurándose de que no haya objetos estáticos en el camino. Si el agente no tiene una ruta de navegación, devolverá la posición del nodo padre del agente. El uso de esta función una vez cada frame de física es necesario para actualizar la lógica interna de la ruta del NavigationAgent.

---

float get_path_length() const 🔗

Devuelve la longitud de la ruta calculada actualmente. El valor devuelto es 0.0 si la ruta aún se está calculando o aún no se ha solicitado ningún cálculo.

---

RID get_rid() const 🔗

Devuelve el RID de este agente en el NavigationServer2D.

---

bool is_navigation_finished() 🔗

Returns true if the agent's navigation has finished. If the target is reachable, navigation ends when the target is reached. If the target is unreachable, navigation ends when the last waypoint of the path is reached.

Note: While true prefer to stop calling update functions like get_next_path_position(). This avoids jittering the standing agent due to calling repeated path updates.

---

bool is_target_reachable() 🔗

Returns true if get_final_position() is within target_desired_distance of the target_position.

---

bool is_target_reached() const 🔗

Returns true if the agent reached the target, i.e. the agent moved within target_desired_distance of the target_position. It may not always be possible to reach the target but it should always be possible to reach the final position. See get_final_position().

---

void set_avoidance_layer_value(layer_number: int, value: bool) 🔗

Based on value, enables or disables the specified layer in the avoidance_layers bitmask, given a layer_number between 1 and 32.

---

void set_avoidance_mask_value(mask_number: int, value: bool) 🔗

Based on value, enables or disables the specified mask in the avoidance_mask bitmask, given a mask_number between 1 and 32.

---

void set_navigation_layer_value(layer_number: int, value: bool) 🔗

Based on value, enables or disables the specified layer in the navigation_layers bitmask, given a layer_number between 1 and 32.

---

void set_navigation_map(navigation_map: RID) 🔗

Sets the RID of the navigation map this NavigationAgent node should use and also updates the agent on the NavigationServer.

---

void set_velocity_forced(velocity: Vector2) 🔗

Replaces the internal velocity in the collision avoidance simulation with velocity. When an agent is teleported to a new position this function should be used in the same frame. If called frequently this function can get agents stuck.