NavigationObstacle2D

Inherits: Node < Object

2D Obstacle used in navigation for collision avoidance.

Description

2D Obstacle used in navigation for collision avoidance. The obstacle needs navigation data to work correctly. NavigationObstacle2D is physics safe.

Note: Obstacles are intended as a last resort option for constantly moving objects that cannot be (re)baked to a navigation mesh efficiently.

Properties

bool	estimate_radius	true
float	radius	1.0

Methods

RID	get_navigation_map ( ) const
RID	get_rid ( ) const
void	set_navigation_map ( RID navigation_map )

Property Descriptions

• bool estimate_radius

Default	true
Setter	set_estimate_radius(value)
Getter	is_radius_estimated()

Enables radius estimation algorithm which uses parent's collision shapes to determine the obstacle radius.

---

• float radius

Default	1.0
Setter	set_radius(value)
Getter	get_radius()

The radius of the agent. Used only if estimate_radius is set to false.

Method Descriptions

• RID get_navigation_map ( ) const

Returns the RID of the navigation map for this NavigationObstacle node. This function returns always the map set on the NavigationObstacle node and not the map of the abstract agent on the NavigationServer. If the agent map is changed directly with the NavigationServer API the NavigationObstacle node will not be aware of the map change. Use set_navigation_map to change the navigation map for the NavigationObstacle and also update the agent on the NavigationServer.

---

• RID get_rid ( ) const

Returns the RID of this obstacle on the NavigationServer2D.

---

• void set_navigation_map ( RID navigation_map )

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