Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

NavMesh.Raycast

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

Parameters

sourcePositionThe origin of the ray.
targetPositionThe end of the ray.
hitHolds the properties of the ray cast resulting location.
passableMaskA mask specifying which NavMesh layers can be passed when tracing the ray.

Returns

bool True if the ray is terminated before reaching target position. Otherwise returns false.

Description

Trace a line between two points on the NavMesh.

This function follows the path of a "ray" between the specified source and target positions on the navmesh. If an obstruction is encountered along the line then a true value is returned and the position and other details of the obstructing object are stored in the hit parameter. This can be used to check if there is a clear shot or line of sight between a character and a target object. This function is preferable to the similar Physics.Raycast because the line tracing is performed in a simpler way using the navmesh and has a lower processing overhead.

	var target: Transform;

function Update () { var hit: NavMeshHit; // Note the negative test condition! Using -1 for the mask // indicates all layers are to be used. if (!NavMesh.Raycast(transform.position, target.position, hit, -1)) { // Target is "visible" from our position. } }

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public Transform target;
    void Update() {
        NavMeshHit hit;
        if (!NavMesh.Raycast(transform.position, target.position, out hit, -1)) {
        }
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public target as Transform

	def Update() as void:
		hit as NavMeshHit
		if not NavMesh.Raycast(transform.position, target.position, , -1):
			pass