Legacy Documentation: Version 5.1
LanguageEnglish
  • C#
  • JS

Script language

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

Collider.Raycast

Switch to Manual
public function Raycast(ray: Ray, out hitInfo: RaycastHit, maxDistance: float): 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.

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