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. This can be done by having the obstacle as a child of a Navigation2D node, or using set_navigation. 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

Node

get_navigation ( ) const

RID

get_rid ( ) const

void

set_navigation ( Node navigation )

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.

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

  • Node get_navigation ( ) const

Returns the Navigation2D node that the obstacle is using for its navigation system.

  • RID get_rid ( ) const

Returns the RID of this obstacle on the Navigation2DServer.

  • void set_navigation ( Node navigation )

Sets the Navigation2D node used by the obstacle. Useful when you don’t want to make the obstacle a child of a Navigation2D node.