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

PolygonId

struct in UnityEngine.Experimental.AI

/

Implemented in:UnityEngine.AIModule

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

Description

Represents a compact identifier for the data of a NavMesh node.

It is used in NavMeshQuery operations for pinpointing and getting access to relevant nodes in the NavMesh. Each node can be used by only one type of agent. See Also: NavMeshSurface.

This identifier becomes invalid once the node gets removed from the NavMesh, either by completely removing the surface or by modifying the surface in the node's immediate vicinity.

See Also: NavMeshQuery.IsValid.

Public Methods

EqualsReturns true if two PolygonId objects refer to the same NavMesh node.
GetHashCodeReturns the hash code for use in collections.
IsNullReturns true if the PolygonId has been created empty and has never pointed to any node in the NavMesh.

Operators

operator !=Returns true if two PolygonId objects refer to different NavMesh nodes or if only one of them is null.
operator ==Returns true if two PolygonId objects refer to the same NavMesh node or if they are both null.