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

NavMeshQuery.GetAgentTypeIdForPolygon

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 int GetAgentTypeIdForPolygon(Experimental.AI.PolygonId polygon);

Parameters

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

Returns

int Agent type identifier.

Description

Returns the identifier of the agent type the NavMesh was baked for or for which the link has been configured.

When NavMesh surfaces are baked or links are configured the Agent Type allowed to use them needs to be specified. Each Agent Type is identified by a unique integer. Operations such as NavMeshQuery.MapLocation, NavMesh.GetSettingsByID, NavMesh.GetSettingsNameFromID, NavMeshBuilder.BuildNavMeshData, and NavMesh.CalculatePath all require an agent type to be specified to distinguish between NavMeshes built for different agent configurations.