Navigation2D

Inherits: Node2D < CanvasItem < Node < Object

2D navigation and pathfinding node.

Description

Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of NavigationPolygon resources. By default, these are automatically collected from child NavigationPolygonInstance nodes, but they can also be added on the fly with navpoly_add.

Method Descriptions

Returns the navigation point closest to the point given. Points are in local coordinate space.


Returns the owner of the NavigationPolygon which contains the navigation point closest to the point given. This is usually a NavigationPolygonInstance. For polygons added via navpoly_add, returns the owner that was given (or null if the owner parameter was omitted).


Returns the path between two given points. Points are in local coordinate space. If optimize is true (the default), the path is smoothed by merging path segments where possible.


Adds a NavigationPolygon. Returns an ID for use with navpoly_remove or navpoly_set_transform. If given, a Transform2D is applied to the polygon. The optional owner is used as return value for get_closest_point_owner.


  • void navpoly_remove ( int id )

Removes the NavigationPolygon with the given ID.


Sets the transform applied to the NavigationPolygon with the given ID.

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 2020-03-07 at 01:35:05. It's the English Stable version because it's what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.