2022-03-15 13:29:32 +01:00
<?xml version="1.0" encoding="UTF-8" ?>
2022-11-20 23:27:04 +01:00
<class name= "NavigationPolygon" inherits= "Resource" version= "3.10" >
2022-03-15 13:29:32 +01:00
<brief_description >
A node that has methods to draw outlines or use indices of vertices to create navigation polygons.
</brief_description>
<description >
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]:
[codeblock]
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
[/codeblock]
Using [method add_polygon] and indices of the vertices array.
[codeblock]
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, 1, 2, 3])
polygon.add_polygon(indices)
$NavigationPolygonInstance.navpoly = polygon
[/codeblock]
</description>
<tutorials >
<link title= "2D Navigation Demo" > https://godotengine.org/asset-library/asset/117</link>
</tutorials>
<methods >
<method name= "add_outline" >
<return type= "void" />
<argument index= "0" name= "outline" type= "PoolVector2Array" />
<description >
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.
</description>
</method>
<method name= "add_outline_at_index" >
<return type= "void" />
<argument index= "0" name= "outline" type= "PoolVector2Array" />
<argument index= "1" name= "index" type= "int" />
<description >
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.
</description>
</method>
<method name= "add_polygon" >
<return type= "void" />
<argument index= "0" name= "polygon" type= "PoolIntArray" />
<description >
Adds a polygon using the indices of the vertices you get when calling [method get_vertices].
</description>
</method>
<method name= "clear_outlines" >
<return type= "void" />
<description >
Clears the array of the outlines, but it doesn't clear the vertices and the polygons that were created by them.
</description>
</method>
<method name= "clear_polygons" >
<return type= "void" />
<description >
Clears the array of polygons, but it doesn't clear the array of outlines and vertices.
</description>
</method>
2022-06-02 09:25:42 +02:00
<method name= "get_mesh" >
<return type= "NavigationMesh" />
<description >
Returns the [NavigationMesh] resulting from this navigation polygon. This navmesh can be used to update the navmesh of a region with the [method NavigationServer.region_set_navmesh] API directly (as 2D uses the 3D server behind the scene).
</description>
</method>
2022-03-15 13:29:32 +01:00
<method name= "get_outline" qualifiers= "const" >
<return type= "PoolVector2Array" />
<argument index= "0" name= "idx" type= "int" />
<description >
Returns a [PoolVector2Array] containing the vertices of an outline that was created in the editor or by script.
</description>
</method>
<method name= "get_outline_count" qualifiers= "const" >
<return type= "int" />
<description >
Returns the number of outlines that were created in the editor or by script.
</description>
</method>
<method name= "get_polygon" >
<return type= "PoolIntArray" />
<argument index= "0" name= "idx" type= "int" />
<description >
Returns a [PoolIntArray] containing the indices of the vertices of a created polygon.
</description>
</method>
<method name= "get_polygon_count" qualifiers= "const" >
<return type= "int" />
<description >
Returns the count of all polygons.
</description>
</method>
<method name= "get_vertices" qualifiers= "const" >
<return type= "PoolVector2Array" />
<description >
Returns a [PoolVector2Array] containing all the vertices being used to create the polygons.
</description>
</method>
<method name= "make_polygons_from_outlines" >
<return type= "void" />
<description >
Creates polygons from the outlines added in the editor or by script.
</description>
</method>
<method name= "remove_outline" >
<return type= "void" />
<argument index= "0" name= "idx" type= "int" />
<description >
Removes an outline created in the editor or by script. You have to call [method make_polygons_from_outlines] for the polygons to update.
</description>
</method>
<method name= "set_outline" >
<return type= "void" />
<argument index= "0" name= "idx" type= "int" />
<argument index= "1" name= "outline" type= "PoolVector2Array" />
<description >
Changes an outline created in the editor or by script. You have to call [method make_polygons_from_outlines] for the polygons to update.
</description>
</method>
<method name= "set_vertices" >
<return type= "void" />
<argument index= "0" name= "vertices" type= "PoolVector2Array" />
<description >
Sets the vertices that can be then indexed to create polygons with the [method add_polygon] method.
</description>
</method>
</methods>
<constants >
</constants>
</class>
