NavigationPolygon

public float AgentRadius { get; set; }

Clearance radius used when baking traversable geometry. Changing it does not automatically rebake existing output; inspect boundaries and paths after baking. It is not a physics-shape or avoidance radius.

public Rect2 BakingRect { get; set; }

If the baking Rect2 has an area the navigation mesh baking will be restricted to its enclosing area.

public Vector2 BakingRectOffset { get; set; }

The position offset applied to the NavigationPolygon.BakingRect Rect2.

public float BorderSize { get; set; }

The size of the non-navigable border around the bake bounding area defined by the NavigationPolygon.BakingRect Rect2. In conjunction with the NavigationPolygon.BakingRect the border size can be used to bake tile aligned navigation meshes without the tile edges being shrunk by NavigationPolygon.AgentRadius.

public float CellSize { get; set; }

The cell size used to rasterize the navigation mesh vertices. Must match with the cell size on the navigation map.

public uint ParsedCollisionMask { get; set; }

The physics layers to scan for static colliders. Only used when NavigationPolygon.ParsedGeometryType is NavigationPolygon.ParsedGeometryTypeEnum.StaticColliders or NavigationPolygon.ParsedGeometryTypeEnum.Both.

public NavigationPolygon.ParsedGeometryTypeEnum ParsedGeometryType { get; set; }

Determines which type of nodes will be parsed as geometry.

public NavigationPolygon.SamplePartitionTypeEnum SamplePartitionType { get; set; }

Partitioning algorithm for creating the navigation mesh polys.

public StringName SourceGeometryGroupName { get; set; }

The group name of nodes that should be parsed for baking source geometry. Only used when NavigationPolygon.SourceGeometryMode is NavigationPolygon.SourceGeometryModeEnum.GroupsWithChildren or NavigationPolygon.SourceGeometryModeEnum.GroupsExplicit.

public NavigationPolygon.SourceGeometryModeEnum SourceGeometryMode { get; set; }

The source of the geometry used when baking.

public void AddOutline(Vector2[] outline);

Appends a Vector2[] that contains the vertices of an outline to the internal array that contains all the outlines.

public void AddOutline(ReadOnlySpan<Vector2> outline);

Appends a Vector2[] that contains the vertices of an outline to the internal array that contains all the outlines.

public void AddOutlineAtIndex(Vector2[] outline, int index);

Adds a Vector2[] that contains the vertices of an outline to the internal array that contains all the outlines at a fixed position.

public void AddOutlineAtIndex(ReadOnlySpan<Vector2> outline, int index);

Adds a Vector2[] that contains the vertices of an outline to the internal array that contains all the outlines at a fixed position.

public void AddPolygon(int[] polygon);

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

public void AddPolygon(ReadOnlySpan<int> polygon);

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

public void Clear();

Clears the internal arrays for vertices and polygon indices.

public void ClearOutlines();

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

public void ClearPolygons();

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

public NavigationMesh GetNavigationMesh();

Returns the NavigationMesh resulting from this navigation polygon. This navigation mesh can be used to update the navigation mesh of a region with the NavigationServer3D.RegionSetNavigationMesh API directly.

public Vector2[] GetOutline(int idx);

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

public int GetOutlineCount();

Returns the number of outlines that were created in the editor or by script.

public bool GetParsedCollisionMaskValue(int layerNumber);

Returns whether or not the specified layer of the NavigationPolygon.ParsedCollisionMask is enabled, given a layer_number between 1 and 32.

public int[] GetPolygon(int idx);

Returns a int[] containing the indices of the vertices of a created polygon.

public int GetPolygonCount();

Returns the navigation resource polygon count. A positive count establishes data presence, rather than map readiness, target reachability or physical character clearance.

public Vector2[] GetVertices();

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

public void MakePolygonsFromOutlines();

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

public void RemoveOutline(int idx);

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

public void SetOutline(int idx, Vector2[] outline);

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

public void SetOutline(int idx, ReadOnlySpan<Vector2> outline);

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

public void SetParsedCollisionMaskValue(int layerNumber, bool value);

Based on value, enables or disables the specified layer in the NavigationPolygon.ParsedCollisionMask, given a layer_number between 1 and 32.

public void SetVertices(Vector2[] vertices);

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

public void SetVertices(ReadOnlySpan<Vector2> vertices);

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