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
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.Close
|ray||The 3D ray defining origin and direction to test.|
|distance||The maximum distance over which to cast the ray.|
|layerMask||Filter to detect colliders only on certain layers.|
|results||Array to receive results.|
int The number of results returned.
Cast a 3D ray against the colliders in the Scene returning the colliders along the ray.
This is useful for finding colliders intersecting an arbitrary 3D ray.
This function is similar to the GetRayIntersectionAll function except that the results are returned in the supplied array. The integer return value is the number of objects that intersect the ray (possibly zero) but the results array will not be resized if it doesn't contain enough elements to report all the results. The significance of this is that no memory is allocated for the results and so garbage collection performance is improved when such calls are performed frequently. The colliders will be placed in the returned array in order of distance from the start of the ray.
Additionally this function is a 3D intersection test therefore any collision normals returned in the RaycastHit2D will be zero.