diff --git a/doc/classes/Navigation2D.xml b/doc/classes/Navigation2D.xml index d2f45133721..364da55f999 100644 --- a/doc/classes/Navigation2D.xml +++ b/doc/classes/Navigation2D.xml @@ -1,9 +1,10 @@ - Class to assist with character navigation and pathfinding. + 2D navigation and pathfinding node. + 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 [method navpoly_add]. @@ -16,6 +17,7 @@ + Returns the navigation point closest to the point given. Points are in local coordinate space. @@ -24,6 +26,7 @@ + Returns the owner of the [NavigationPolygon] which contains the navigation point closest to the point given. This is usually a [NavigtionPolygonInstance]. For polygons added via [method navpoly_add], returns the owner that was given (or [code]null[/code] if the [code]owner[/code] parameter was omitted). @@ -36,6 +39,7 @@ + Returns the path between two given points. Points are in local coordinate space. If [code]optimize[/code] is [code]true[/code] (the default), the path is smoothed by merging path segments where possible. @@ -48,6 +52,7 @@ + Adds a [NavigationPolygon]. Returns an ID for use with [method navpoly_remove] or [method navpoly_set_transform]. If given, a [Transform2D] is applied to the polygon. The optional [code]owner[/code] is used as return value for [method get_closest_point_owner]. @@ -56,6 +61,7 @@ + Removes the [NavigationPolygon] with the given ID. @@ -66,6 +72,7 @@ + Sets the transform applied to the [NavigationPolygon] with the given ID.