Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Experimental: this API is experimental and might be changed or removed in the future.

NavMeshQuery.IsValid

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

public method IsValid(polygon: Experimental.AI.PolygonId): bool;
public bool IsValid(Experimental.AI.PolygonId polygon);

Parameters

polygonIdentifier of the NavMesh node to be checked.

Description

Returns true if the node referenced by the specified PolygonId is active in the NavMesh.

NavMesh nodes become invalid when the NavMesh surface or the links they belong are removed or when they have been replaced due to modification of the NavMesh in their region. The NavMesh surface and links may be removed by calls to NavMesh.RemoveNavMeshData, NavMesh.RemoveLink. The NavMesh is modified by calling NavMeshBuilder.UpdateNavMeshData or carving the NavMesh using a NavMeshObstacle.


public method IsValid(location: Experimental.AI.NavMeshLocation): bool;
public bool IsValid(Experimental.AI.NavMeshLocation location);

Parameters

locationLocation on the NavMesh to be checked. Same as checking location.polygon directly.

Description

Returns true if the node referenced by the PolygonId contained in the NavMeshLocation is active in the NavMesh.

Did you find this page useful? Please give it a rating: