Class reference
NavigationLink2D
Inherits Node2D
A link between two positions on NavigationRegion2Ds that agents can be routed through.
Description
A link between two positions on NavigationRegion2Ds that agents can be routed through. These positions can be on the same NavigationRegion2D or on two different ones. Links are useful to express navigation methods other than traveling along the surface of the navigation polygon, such as ziplines, teleporters, or gaps that can be jumped across.
Properties
bool bidirectional = true
bool bidirectional = trueWhether this link can be traveled in both directions or only from start_position to end_position.
bool enabled = true
bool enabled = trueWhether this link is currently active. If false, NavigationServer2D.map_get_path() will ignore this link.
Vector2 end_position = Vector2(0, 0)
Vector2 end_position = Vector2(0, 0)Ending position of the link. This position will search out the nearest polygon in the navigation mesh to attach to. The distance the link will search is controlled by NavigationServer2D.map_set_link_connection_radius().
float enter_cost = 0.0
float enter_cost = 0.0When pathfinding enters this link from another regions navigation mesh the enter_cost value is added to the path distance for determining the shortest path.
int navigation_layers = 1
int navigation_layers = 1A bitfield determining all navigation layers the link belongs to. These navigation layers will be checked when requesting a path with NavigationServer2D.map_get_path().
Vector2 start_position = Vector2(0, 0)
Vector2 start_position = Vector2(0, 0)Starting position of the link. This position will search out the nearest polygon in the navigation mesh to attach to. The distance the link will search is controlled by NavigationServer2D.map_set_link_connection_radius().
float travel_cost = 1.0
float travel_cost = 1.0When pathfinding moves along the link the traveled distance is multiplied with travel_cost for determining the shortest path.
Methods
Vector2 get_global_end_position() const
Vector2 get_global_end_position() constReturns the end_position that is relative to the link as a global position.
Vector2 get_global_start_position() const
Vector2 get_global_start_position() constReturns the start_position that is relative to the link as a global position.
bool get_navigation_layer_value(int layer_number) const
bool get_navigation_layer_value(int layer_number) constReturns whether or not the specified layer of the navigation_layers bitmask is enabled, given a layer_number between 1 and 32.
RID get_navigation_map() const
RID get_navigation_map() constReturns the current navigation map RID used by this link.
RID get_rid() const
RID get_rid() constReturns the RID of this link on the NavigationServer2D.
void set_global_end_position(Vector2 position)
Vector2 position)Sets the end_position that is relative to the link from a global position.
void set_global_start_position(Vector2 position)
Vector2 position)Sets the start_position that is relative to the link from a global position.
void set_navigation_layer_value(int layer_number, bool value)
int layer_number, bool value)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(RID navigation_map)
RID navigation_map)Sets the RID of the navigation map this link should use. By default the link will automatically join the World2D default navigation map so this function is only required to override the default map.