Select your preferred scripting language. All code snippets will be displayed in this language.
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| areaName | Name of the area to look up. |
int Index if the specified are, or -1 if no area found.
Returns the area index for a named NavMesh area type.
#pragma strict // NearestPointOnWater.cs public class NearestPointOnWater extends MonoBehaviour { function Update() { // Find nearest point on water. var waterMask: int = 1 << NavMesh.GetAreaFromName("water"); var hit: NavMeshHit; if (NavMesh.SamplePosition(transform.position, hit, 2.0f, waterMask)) { Debug.DrawRay(hit.position, Vector3.up, Color.blue); } } }
// NearestPointOnWater.cs using UnityEngine; using System.Collections; 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.