Version: 2018.2 (switch to 2018.3b or 2017.4)
LanguageEnglish
  • C#

Collider.Raycast

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

Submission failed

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

Close

Cancel

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

Parameters

rayThe starting point and direction of the ray.
hitInfoIf true is returned, hitInfo will contain more information about where the collider was hit.
maxDistanceThe max length of the ray.

Returns

bool True when the ray intersects the collider, otherwise false.

Description

Casts a Ray that ignores all Colliders except this one.

See Also: RaycastHit.

using UnityEngine;
using System.Collections;

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 (Input.GetMouseButtonDown(0)) { Ray ray = Camera.main.ScreenPointToRay(Input.mousePosition); RaycastHit hit;

if (coll.Raycast(ray, out hit, 100.0f)) { transform.position = ray.GetPoint(100.0f); } } } }

Did you find this page useful? Please give it a rating: