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;

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);
	    }
	}