diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml index b29e19e5d8d..4ede80b98c7 100644 --- a/doc/classes/NavigationPolygon.xml +++ b/doc/classes/NavigationPolygon.xml @@ -1,8 +1,27 @@ + A node that has methods to draw outlines or use indices of vertices to create navigation polygons. + There are two ways to create polygons. Either by using the [method add_outline] method or using the [method add_polygon] method. + Using [method add_outline]: + [code] + var polygon = NavigationPolygon.new() + var outline = PoolVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) + polygon.add_outline(outline) + polygon.make_polygons_from_outlines() + $NavigationPolygonInstance.navpoly = polygon + [/code] + Using [method add_polygon] and indices of the vertices array. + [code] + var polygon = NavigationPolygon.new() + var vertices = PoolVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) + polygon.set_vertices(vertices) + var indices = PoolIntArray(0, 3, 1) + polygon.add_polygon(indices) + $NavigationPolygonInstance.navpoly = polygon + [/code] @@ -15,6 +34,7 @@ + Appends a [PoolVector2Array] that contains the vertices of an outline to the internal array that contains all the outlines. You have to call [method make_polygons_from_outlines] in order for this array to be converted to polygons that the engine will use. @@ -25,6 +45,7 @@ + Adds a [PoolVector2Array] that contains the vertices of an outline to the internal array that contains all the outlines at a fixed position. You have to call [method make_polygons_from_outlines] in order for this array to be converted to polygons that the engine will use. @@ -33,18 +54,21 @@ + Adds a polygon using the indices of the vertices you get when calling [method get_vertices]. + Clears the array of the outlines, but it doesn't clear the vertices and the polygons that were created by them. + Clears the array of polygons, but it doesn't clear the array of outlines and vertices. @@ -53,12 +77,14 @@ + Returns a [PoolVector2Array] containing the vertices of an outline that was created in the editor or by script. + Returns the number of outlines that were created in the editor or by script. @@ -67,24 +93,28 @@ + Returns a [PoolIntArray] containing the indices of the vertices of a created polygon. + Returns the count of all polygons. + Returns a [PoolVector2Array] containing all the vertices being used to create the polygons. + Creates polygons from the outlines added in the editor or by script. @@ -93,6 +123,7 @@ + Removes an outline created in the editor or by script. You have to call [method make_polygons_from_outlines] for the polygons to update. @@ -103,6 +134,7 @@ + Changes an outline created in the editor or by script. You have to call [method make_polygons_from_outlines] for the polygons to update. @@ -111,6 +143,7 @@ + Sets the vertices that can be then indexed to create polygons with the [method add_polygon] method.