Version: 5.6 (switch to 2017.1b)
LanguageEnglish
  • C#
  • JS

Script language

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

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 function Raycast(ray: Ray, out hitInfo: RaycastHit, maxDistance: float): bool;
public bool Raycast(Ray ray, out RaycastHit hitInfo, float maxDistance);

Parameters

ray The starting point and direction of the ray.
hitInfo If true is returned, hitInfo will contain more information about where the collider was hit (See Also: RaycastHit).
maxDistance The max length of the ray.

Returns

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

Description

Casts a Ray that ignores all Colliders except this one.

var coll: Collider;

function Start() { coll = GetComponent.<Collider>(); }

function Update(){ // Move this object to the position clicked by the mouse. if (Input.GetMouseButtonDown(0)) { var ray : Ray = Camera.main.ScreenPointToRay(Input.mousePosition); var hit : RaycastHit;

if (coll.Raycast(ray, hit, 100.0)) { transform.position = ray.GetPoint(100.0); } } }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { public Collider coll; void Start() { coll = GetComponent<Collider>(); } void Update() { 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); } } }