Version: 2021.3
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

NavMeshQuery.GetPolygonType

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public Experimental.AI.NavMeshPolyTypes GetPolygonType(Experimental.AI.PolygonId polygon);

Parameters

polygon Identifier of a node from a NavMesh surface or link.

Returns

NavMeshPolyTypes Ground when the node is a polygon on a NavMesh surface.
OffMeshConnection when the node is a NavMeshLink or an Off-mesh Link.

Description

Returns whether the NavMesh node is a polygon or a link.

The type can be determined even after the specified node has become invalid in the query's NavMeshWorld.

Known issue, to be fixed: If the query's NavMeshWorld is invalid for any reason, the method returns NavMeshPolyTypes.OffMeshConnection.

Additional resources: NavMeshPolyTypes, NavMeshQuery.IsValid, NavMeshWorld.IsValid.