Version: 2018.2 (switch to 2018.3b or 2017.4)
LanguageEnglish
  • C#

Physics2D.GetRayIntersection

Suggest a change

Success!

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

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.

Close

Cancel

public static RaycastHit2D GetRayIntersection(Ray ray, float distance = Mathf.Infinity, int layerMask = DefaultRaycastLayers);

Parameters

rayThe 3D ray defining origin and direction to test.
distanceMaximum distance over which to cast the ray.
layerMaskFilter to detect colliders only on certain layers.

Returns

RaycastHit2D The cast results returned.

Description

Cast a 3D ray against the colliders in the scene returning the first collider along the ray.

This is useful for finding colliders intersecting an arbitrary 3D ray.

Note that this function will allocate memory for the returned RaycastHit2D object. You can use GetRayIntersectionNonAlloc to avoid this overhead if you need to make such calls frequently.

Additionally that this function is a 3D intersection test therefore any collision normals returned in the RaycastHit2D will be zero.

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