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

NavigationLink3D

Inherits: Node3D < Node < Object

A link between two positions on NavigationRegion3Ds that agents can be routed through.

Description

A link between two positions on NavigationRegion3Ds that agents can be routed through. These positions can be on the same NavigationRegion3D or on two different ones. Links are useful to express navigation methods other than traveling along the surface of the navigation mesh, such as ziplines, teleporters, or gaps that can be jumped across.

Tutorials

• Using NavigationLinks

Properties

bool	bidirectional	true
bool	enabled	true
Vector3	end_position	Vector3(0, 0, 0)
float	enter_cost	0.0
int	navigation_layers	1
Vector3	start_position	Vector3(0, 0, 0)
float	travel_cost	1.0

Methods

Vector3	get_global_end_position ( ) const
Vector3	get_global_start_position ( ) const
bool	get_navigation_layer_value ( int layer_number ) const
void	set_global_end_position ( Vector3 position )
void	set_global_start_position ( Vector3 position )
void	set_navigation_layer_value ( int layer_number, bool value )

---

Property Descriptions

bool bidirectional = true

• void set_bidirectional ( bool value )

• bool is_bidirectional ( )

Whether this link can be traveled in both directions or only from start_position to end_position.

---

bool enabled = true

• void set_enabled ( bool value )

• bool is_enabled ( )

Whether this link is currently active. If false, NavigationServer3D.map_get_path will ignore this link.

---

Vector3 end_position = Vector3(0, 0, 0)

• void set_end_position ( Vector3 value )

• Vector3 get_end_position ( )

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

---

float enter_cost = 0.0

• void set_enter_cost ( float value )

• float get_enter_cost ( )

When 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

• void set_navigation_layers ( int value )

• int get_navigation_layers ( )

A bitfield determining all navigation layers the link belongs to. These navigation layers will be checked when requesting a path with NavigationServer3D.map_get_path.

---

Vector3 start_position = Vector3(0, 0, 0)

• void set_start_position ( Vector3 value )

• Vector3 get_start_position ( )