Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

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

Sumbission failed

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

Close

Cancel

Switch to Manual
public function Raycast(ray: Ray, hitInfo: RaycastHit, distance: float): bool;
public bool Raycast(Ray ray, RaycastHit hitInfo, float distance);
public def Raycast(ray as Ray, hitInfo as RaycastHit, distance as float) as bool

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).
distance The 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.

	function Update(){
	    var ray : Ray = Camera.main.ScreenPointToRay(Input.mousePosition);
	    var hit : RaycastHit;
	    
	    if (collider.Raycast(ray, hit, 100.0)) {
	        Debug.DrawLine(ray.origin, hit.point);
	    }
	}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    void Update() {
        Ray ray = Camera.main.ScreenPointToRay(Input.mousePosition);
        RaycastHit hit;
        if (collider.Raycast(ray, out hit, 100.0F))
            Debug.DrawLine(ray.origin, hit.point);
        
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def Update() as void:
		ray as Ray = Camera.main.ScreenPointToRay(Input.mousePosition)
		hit as RaycastHit
		if collider.Raycast(ray, , 100.0F):
			Debug.DrawLine(ray.origin, hit.point)