Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

Raycast(ray: Ray, hitInfo: RaycastHit, distance: float): bool;
bool Raycast(Ray ray, RaycastHit hitInfo, float distance);
def Raycast(ray as Ray, hitInfo as RaycastHit, distance as float) as bool

Parameters

rayThe starting point and direction of the ray.
hitInfoIf true is returned, hitInfo will contain more information about where the collider was hit (See Also: RaycastHit).
distanceThe 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)