NavigationPolygon

Category: Core

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 or using the add_polygon method.

Using :

Using add_polygon and indices of the vertices array.

var vertices = PoolVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)])
$NavigationPolygonInstance.navpoly = polygon

• void add_outline ( outline )

• void add_outline_at_index ( PoolVector2Array outline, index )

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 in order for this array to be converted to polygons that the engine will use.

• void add_polygon ( PoolIntArray polygon )

Adds a polygon using the indices of the vertices you get when calling .

• void clear_outlines ( )

Clears the array of the outlines, but it doesn’t clear the vertices and the polygons that were created by them.

• void clear_polygons ( )

Clears the array of polygons, but it doesn’t clear the array of outlines and vertices.

Returns a PoolVector2Array containing the vertices of an outline that was created in the editor or by script.

• get_outline_count ( ) const

• PoolIntArray get_polygon ( idx )

Returns a PoolIntArray containing the indices of the vertices of a created polygon.

• get_polygon_count ( ) const

Returns the count of all polygons.

• PoolVector2Array get_vertices ( ) const

Returns a containing all the vertices being used to create the polygons.

• void make_polygons_from_outlines ( )

Creates polygons from the outlines added in the editor or by script.

• void remove_outline ( int idx )

Removes an outline created in the editor or by script. You have to call for the polygons to update.

• void set_outline ( int idx, outline )

Sets the vertices that can be then indexed to create polygons with the add_polygon method.