Raycast
Trace a line between two points on the NavMesh.
Read time 2 minutesLast updated 12 days ago
Definition
- Type: Method
- Namespace: UnityEngine.AI
- Assembly: UnityEngine.AIModule
Raycast(Vector3, Vector3, NavMeshHit, int)
Trace a line between two points on the NavMesh.
public static bool Raycast(Vector3 sourcePosition, Vector3 targetPosition, out NavMeshHit hit, int areaMask)
Parameters
The origin of the ray.
The end of the ray.
Holds the properties of the ray cast resulting location.
A bitfield mask specifying which NavMesh areas can be passed when tracing the ray.
Returns
Type | Description |
|---|---|
| bool | True if the ray is terminated before reaching target position. Otherwise returns false. |
Remarks
The source and destination points are first mapped on the NavMesh, then a ray is traced from the source point towards the target. If the ray hits a NavMesh boundary, the function returns true and the hit data is filled. If the path from the source to target is unobstructed, the function returns false.
If the raycast terminates on an outer edge, is 0; otherwise it contains the area mask of the blocking polygon.
hit.maskThis function can be used to check if an agent can walk unobstructed between two points on the NavMesh. For example if you character has an evasive dodge move which needs space, you can shoot a ray from the characters location to multiple directions to find a spot where the character can dodge to.
The Raycast is different from physics ray cast because it works on “2.5D”, on the NavMesh. The difference to physics ray casts is that NavMesh ray casts can detect all kinds of navigation obstructions, such as holes in the ground, and it can also climb up slopes, if the area is navigable.
If you want to find the nearest point on the NavMesh, use physics ray cast to find a point in the world. For more information, refer to the Move an Agent to a Position Clicked by the Mouse example.
Examples
using UnityEngine;using UnityEngine.AI;public class TargetReachable : MonoBehaviour{ public Transform target; private NavMeshHit hit; private bool blocked = false; void Update() { blocked = NavMesh.Raycast(transform.position, target.position, out hit, NavMesh.AllAreas); Debug.DrawLine(transform.position, target.position, blocked ? Color.red : Color.green); if (blocked) Debug.DrawRay(hit.position, Vector3.up, Color.red); }}
Raycast(Vector3, Vector3, NavMeshHit, NavMeshQueryFilter)
Traces a line between two positions on the NavMesh, subject to the constraints defined by the filter argument.
public static bool Raycast(Vector3 sourcePosition, Vector3 targetPosition, out NavMeshHit hit, NavMeshQueryFilter filter)
Parameters
The origin of the ray.
The end of the ray.
Holds the properties of the ray cast resulting location.
A filter specifying which NavMesh areas can be passed when tracing the ray.
Returns
Type | Description |
|---|---|
| bool | True if the ray is terminated before reaching target position. Otherwise returns false. |
Remarks
The line is terminated on outer edges or a non-passable area.