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.

NavMesh.GetAreaFromName

public static int GetAreaFromName(string areaName);

Parameters

areaNameName of the area to look up.

Returns

int Index if the specified are, or -1 if no area found.

Description

Returns the area index for a named NavMesh area type.

// NearestPointOnWater
using UnityEngine;
using UnityEngine.AI;

public class NearestPointOnWater : MonoBehaviour { void Update() { // Find nearest point on water. int waterMask = 1 << NavMesh.GetAreaFromName("water"); NavMeshHit hit; if (NavMesh.SamplePosition(transform.position, out hit, 2.0f, waterMask)) { Debug.DrawRay(hit.position, Vector3.up, Color.blue); } } }

See Also: Areas and Costs to learn how to use different Area types.

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