Legacy Documentation: Version 2017.2 (Go to current version)
  • C#
  • JS

Script language

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


Suggest a change


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.


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.



public method IntersectRay(ray: Ray): bool;
public bool IntersectRay(Ray ray);


Does ray intersect this bounding box?

// Function to detect if a ray (representing a beam weapon, say)
// makes contact with the collider's bounds.

var coll: Collider;

function Start() { // Store a reference to the collider once at startup. coll = GetComponent.<Collider>(); }

function DetectHit(ray: Ray) { return coll.bounds.IntersectRay(ray); }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { public Collider coll; void Start() { coll = GetComponent<Collider>(); } bool DetectHit(Ray ray) { return coll.bounds.IntersectRay(ray); } }

public method IntersectRay(ray: Ray, out distance: float): bool;
public bool IntersectRay(Ray ray, out float distance);


Does ray intersect this bounding box?

When the function returns true, the distance to the ray's origin will be returned in the distance parameter.

Did you find this page useful? Please give it a rating: