Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

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

NavMesh.FindClosestEdge

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function FindClosestEdge(sourcePosition: Vector3, hit: NavMeshHit, passableMask: int): bool;
public static bool FindClosestEdge(Vector3 sourcePosition, NavMeshHit hit, int passableMask);
public static def FindClosestEdge(sourcePosition as Vector3, hit as NavMeshHit, passableMask as int) as bool

Parameters

sourcePosition The origin of the distance query.
hit Holds the properties of the resulting location.
passableMask A mask specifying which NavMesh layers can be passed when finding the nearest edge.

Returns

bool True if a nearest edge is found.

Description

Locate the closest NavMesh edge from a point on the NavMesh.

The returned NavMeshHit object contains the position and details of the nearest point on the nearest edge of the navmesh. Since an edge typically corresponds to a wall or other large object, this could be used to make a character take cover as close to the wall as possible.

	var mesh: NavMesh;
	var player: Transform;

// Move a marker object to show a position of cover // that the player should head for. function IndicateCoverPosition() { var hit: NavMeshHit; if (mesh.FindClosestEdge(player.position, hit, -1)) { transform.position = hit.position; } }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public NavMesh mesh;
    public Transform player;
    void IndicateCoverPosition() {
        NavMeshHit hit;
        if (mesh.FindClosestEdge(player.position, out hit, -1))
            transform.position = hit.position;
        
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public mesh as NavMesh

	public player as Transform

	def IndicateCoverPosition() as void:
		hit as NavMeshHit
		if mesh.FindClosestEdge(player.position, , -1):
			transform.position = hit.position