NavigationAgent2D

Inherits: Node < Object

There is currently no description for this class. Please help us by contributing one!

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

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 )

There is currently no description for this signal. Please help us by contributing one!

There is currently no description for this signal. Please help us by contributing one!

path_changed ( )

There is currently no description for this signal. Please help us by contributing one!

target_reached ( )

There is currently no description for this signal. Please help us by contributing one!

velocity_computed ( Vector2 safe_velocity )

There is currently no description for this signal. Please help us by contributing one!

waypoint_reached ( Dictionary details )

There is currently no description for this signal. Please help us by contributing one!

Property Descriptions

bool avoidance_enabled = false

void set_avoidance_enabled ( bool value )
bool get_avoidance_enabled ( )

There is currently no description for this property. Please help us by contributing one!

int avoidance_layers = 1

void set_avoidance_layers ( int value )
int get_avoidance_layers ( )

There is currently no description for this property. Please help us by contributing one!

int avoidance_mask = 1

void set_avoidance_mask ( int value )
int get_avoidance_mask ( )

There is currently no description for this property. Please help us by contributing one!

float avoidance_priority = 1.0

void set_avoidance_priority ( float value )
float get_avoidance_priority ( )

There is currently no description for this property. Please help us by contributing one!

bool debug_enabled = false

void set_debug_enabled ( bool value )
bool get_debug_enabled ( )

There is currently no description for this property. Please help us by contributing one!

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

void set_debug_path_custom_color ( Color value )
Color get_debug_path_custom_color ( )

There is currently no description for this property. Please help us by contributing one!

float debug_path_custom_line_width = -1.0

void set_debug_path_custom_line_width ( float value )
float get_debug_path_custom_line_width ( )

There is currently no description for this property. Please help us by contributing one!

float debug_path_custom_point_size = 4.0

void set_debug_path_custom_point_size ( float value )
float get_debug_path_custom_point_size ( )

There is currently no description for this property. Please help us by contributing one!

bool debug_use_custom = false

void set_debug_use_custom ( bool value )
bool get_debug_use_custom ( )

There is currently no description for this property. Please help us by contributing one!

int max_neighbors = 10

void set_max_neighbors ( int value )
int get_max_neighbors ( )

There is currently no description for this property. Please help us by contributing one!

float max_speed = 100.0

void set_max_speed ( float value )
float get_max_speed ( )

There is currently no description for this property. Please help us by contributing one!

int navigation_layers = 1

void set_navigation_layers ( int value )
int get_navigation_layers ( )

There is currently no description for this property. Please help us by contributing one!

float neighbor_distance = 500.0

void set_neighbor_distance ( float value )
float get_neighbor_distance ( )

There is currently no description for this property. Please help us by contributing one!

float path_desired_distance = 20.0

void set_path_desired_distance ( float value )
float get_path_desired_distance ( )

There is currently no description for this property. Please help us by contributing one!

float path_max_distance = 100.0

void set_path_max_distance ( float value )
float get_path_max_distance ( )

There is currently no description for this property. Please help us by contributing one!

BitField<PathMetadataFlags> path_metadata_flags = 7

void set_path_metadata_flags ( BitField<PathMetadataFlags> value )
BitField<PathMetadataFlags> get_path_metadata_flags ( )

There is currently no description for this property. Please help us by contributing one!

PathPostProcessing path_postprocessing = 0

void set_path_postprocessing ( PathPostProcessing value )
PathPostProcessing get_path_postprocessing ( )

There is currently no description for this property. Please help us by contributing one!

PathfindingAlgorithm pathfinding_algorithm = 0

void set_pathfinding_algorithm ( PathfindingAlgorithm value )
PathfindingAlgorithm get_pathfinding_algorithm ( )

There is currently no description for this property. Please help us by contributing one!

float radius = 10.0

void set_radius ( float value )
float get_radius ( )

There is currently no description for this property. Please help us by contributing one!

float simplify_epsilon = 0.0

void set_simplify_epsilon ( float value )
float get_simplify_epsilon ( )

There is currently no description for this property. Please help us by contributing one!

bool simplify_path = false

void set_simplify_path ( bool value )
bool get_simplify_path ( )

There is currently no description for this property. Please help us by contributing one!

float target_desired_distance = 10.0

void set_target_desired_distance ( float value )
float get_target_desired_distance ( )

There is currently no description for this property. Please help us by contributing one!

Vector2 target_position = Vector2(0, 0)

void set_target_position ( Vector2 value )
Vector2 get_target_position ( )

There is currently no description for this property. Please help us by contributing one!

float time_horizon_agents = 1.0

void set_time_horizon_agents ( float value )
float get_time_horizon_agents ( )

There is currently no description for this property. Please help us by contributing one!

float time_horizon_obstacles = 0.0

void set_time_horizon_obstacles ( float value )
float get_time_horizon_obstacles ( )

There is currently no description for this property. Please help us by contributing one!

Vector2 velocity = Vector2(0, 0)

void set_velocity ( Vector2 value )
Vector2 get_velocity ( )

There is currently no description for this property. Please help us by contributing one!

Method Descriptions

float distance_to_target ( ) const

There is currently no description for this method. Please help us by contributing one!

bool get_avoidance_layer_value ( int layer_number ) const

There is currently no description for this method. Please help us by contributing one!

bool get_avoidance_mask_value ( int mask_number ) const

There is currently no description for this method. Please help us by contributing one!

There is currently no description for this method. Please help us by contributing one!

There is currently no description for this method. Please help us by contributing one!

There is currently no description for this method. Please help us by contributing one!

Vector2 get_final_position ( )

There is currently no description for this method. Please help us by contributing one!

There is currently no description for this method. Please help us by contributing one!

There is currently no description for this method. Please help us by contributing one!

Vector2 get_next_path_position ( )

There is currently no description for this method. Please help us by contributing one!

RID get_rid ( ) const

There is currently no description for this method. Please help us by contributing one!

There is currently no description for this method. Please help us by contributing one!

bool is_target_reachable ( )

There is currently no description for this method. Please help us by contributing one!

bool is_target_reached ( ) const

There is currently no description for this method. Please help us by contributing one!

void set_avoidance_layer_value ( int layer_number, bool value )

There is currently no description for this method. Please help us by contributing one!

void set_avoidance_mask_value ( int mask_number, bool value )

There is currently no description for this method. Please help us by contributing one!

There is currently no description for this method. Please help us by contributing one!

There is currently no description for this method. Please help us by contributing one!

void set_velocity_forced ( Vector2 velocity )

There is currently no description for this method. Please help us by contributing one!