Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

Raycast(Ray, out RaycastHit, float)

Casts a Ray that ignores all Colliders except this one.
Read time 1 minuteLast updated 5 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.PhysicsModule

Raycast(Ray, RaycastHit, float)

public bool Raycast(Ray ray, out RaycastHit hitInfo, float maxDistance)

Parameters

ray

Ray
The starting point and direction of the ray.

hitInfo

RaycastHit
If true is returned, 
hitInfo
will contain more information about where the collider was hit.

maxDistance

float
The max length of the ray.

Returns

Type

Description

boolTrue when the ray intersects the collider, otherwise false.

Remarks

Additional Resources: RaycastHit.

Examples

using UnityEngine;using System.Collections;using UnityEngine.InputSystem;public class ExampleClass : MonoBehaviour{    public Collider coll;    void Start()    {        coll = GetComponent<Collider>();    }    void Update()    {        // Move this object to the position clicked by the mouse.        if (Mouse.current.leftButton.wasPressedThisFrame)        {            Ray ray = Camera.main.ScreenPointToRay(Mouse.current.position.ReadValue());            RaycastHit hit;            if (coll.Raycast(ray, out hit, 100.0f))            {                transform.position = ray.GetPoint(100.0f);            }        }    }}