2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 09:03:48 +08:00
<class name= "NavigationPolygon" inherits= "Resource" version= "4.0" >
2017-09-13 04:42:36 +08:00
<brief_description >
2018-10-22 01:38:57 +08:00
A node that has methods to draw outlines or use indices of vertices to create navigation polygons.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2019-06-22 07:04:47 +08:00
There are two ways to create polygons. Either by using the [method add_outline] method, or using the [method add_polygon] method.
2018-10-22 01:38:57 +08:00
Using [method add_outline]:
2020-11-01 01:54:17 +08:00
[codeblocks]
[gdscript]
2018-10-22 01:38:57 +08:00
var polygon = NavigationPolygon.new()
2020-02-18 20:59:24 +08:00
var outline = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)])
2018-10-22 01:38:57 +08:00
polygon.add_outline(outline)
polygon.make_polygons_from_outlines()
2020-02-28 15:05:04 +08:00
$NavigationRegion2D.navpoly = polygon
2020-11-01 01:54:17 +08:00
[/gdscript]
[csharp]
var polygon = new NavigationPolygon();
var outline = new Vector2[] { new Vector2(0, 0), new Vector2(0, 50), new Vector2(50, 50), new Vector2(50, 0) };
polygon.AddOutline(outline);
polygon.MakePolygonsFromOutlines();
GetNode< NavigationRegion2D> ("NavigationRegion2D").Navpoly = polygon;
[/csharp]
[/codeblocks]
2018-10-22 01:38:57 +08:00
Using [method add_polygon] and indices of the vertices array.
2020-11-01 01:54:17 +08:00
[codeblocks]
[gdscript]
2018-10-22 01:38:57 +08:00
var polygon = NavigationPolygon.new()
2020-02-18 20:59:24 +08:00
var vertices = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)])
2020-11-01 01:54:17 +08:00
polygon.vertices = vertices
2020-02-26 01:10:58 +08:00
var indices = PackedInt32Array(0, 3, 1)
2018-10-22 01:38:57 +08:00
polygon.add_polygon(indices)
2020-02-28 15:05:04 +08:00
$NavigationRegion2D.navpoly = polygon
2020-11-01 01:54:17 +08:00
[/gdscript]
[csharp]
var polygon = new NavigationPolygon();
var vertices = new Vector2[] { new Vector2(0, 0), new Vector2(0, 50), new Vector2(50, 50), new Vector2(50, 0) };
polygon.Vertices = vertices;
var indices = new int[] { 0, 3, 1 };
polygon.AddPolygon(indices);
GetNode< NavigationRegion2D> ("NavigationRegion2D").Navpoly = polygon;
[/csharp]
[/codeblocks]
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
2020-10-01 16:34:47 +08:00
<link title= "2D Navigation Demo" > https://godotengine.org/asset-library/asset/117</link>
2017-09-13 04:42:36 +08:00
</tutorials>
<methods >
<method name= "add_outline" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "outline" type= "PackedVector2Array" />
2017-09-13 04:42:36 +08:00
<description >
2020-02-18 20:59:24 +08:00
Appends a [PackedVector2Array] 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.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "add_outline_at_index" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "outline" type= "PackedVector2Array" />
<argument index= "1" name= "index" type= "int" />
2017-09-13 04:42:36 +08:00
<description >
2020-02-18 20:59:24 +08:00
Adds a [PackedVector2Array] 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.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "add_polygon" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "polygon" type= "PackedInt32Array" />
2017-09-13 04:42:36 +08:00
<description >
2018-10-22 01:38:57 +08:00
Adds a polygon using the indices of the vertices you get when calling [method get_vertices].
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "clear_outlines" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2017-09-13 04:42:36 +08:00
<description >
2018-10-22 01:38:57 +08:00
Clears the array of the outlines, but it doesn't clear the vertices and the polygons that were created by them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "clear_polygons" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2017-09-13 04:42:36 +08:00
<description >
2018-10-22 01:38:57 +08:00
Clears the array of polygons, but it doesn't clear the array of outlines and vertices.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "get_outline" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "PackedVector2Array" />
<argument index= "0" name= "idx" type= "int" />
2017-09-13 04:42:36 +08:00
<description >
2020-02-18 20:59:24 +08:00
Returns a [PackedVector2Array] containing the vertices of an outline that was created in the editor or by script.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "get_outline_count" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "int" />
2017-09-13 04:42:36 +08:00
<description >
2018-10-22 01:38:57 +08:00
Returns the number of outlines that were created in the editor or by script.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "get_polygon" >
2021-07-30 21:28:05 +08:00
<return type= "PackedInt32Array" />
<argument index= "0" name= "idx" type= "int" />
2017-09-13 04:42:36 +08:00
<description >
2020-02-26 01:10:58 +08:00
Returns a [PackedInt32Array] containing the indices of the vertices of a created polygon.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "get_polygon_count" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "int" />
2017-09-13 04:42:36 +08:00
<description >
2018-10-22 01:38:57 +08:00
Returns the count of all polygons.
2017-09-13 04:42:36 +08:00
</description>
</method>
2017-12-07 15:29:38 +08:00
<method name= "get_vertices" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "PackedVector2Array" />
2017-12-07 15:29:38 +08:00
<description >
2020-02-18 20:59:24 +08:00
Returns a [PackedVector2Array] containing all the vertices being used to create the polygons.
2017-12-07 15:29:38 +08:00
</description>
</method>
2017-09-13 04:42:36 +08:00
<method name= "make_polygons_from_outlines" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2017-09-13 04:42:36 +08:00
<description >
2018-10-22 01:38:57 +08:00
Creates polygons from the outlines added in the editor or by script.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "remove_outline" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "idx" type= "int" />
2017-09-13 04:42:36 +08:00
<description >
2018-10-22 01:38:57 +08:00
Removes an outline created in the editor or by script. You have to call [method make_polygons_from_outlines] for the polygons to update.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "set_outline" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "idx" type= "int" />
<argument index= "1" name= "outline" type= "PackedVector2Array" />
2017-09-13 04:42:36 +08:00
<description >
2018-10-22 01:38:57 +08:00
Changes an outline created in the editor or by script. You have to call [method make_polygons_from_outlines] for the polygons to update.
2017-09-13 04:42:36 +08:00
</description>
</method>
2017-12-07 15:29:38 +08:00
<method name= "set_vertices" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "vertices" type= "PackedVector2Array" />
2017-12-07 15:29:38 +08:00
<description >
2018-10-22 01:38:57 +08:00
Sets the vertices that can be then indexed to create polygons with the [method add_polygon] method.
2017-12-07 15:29:38 +08:00
</description>
</method>
2017-09-13 04:42:36 +08:00
</methods>
</class>