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

RaycastHit2D

struct in UnityEngine

/

Implemented in:UnityEngine.Physics2DModule

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

Description

Information returned about an object detected by a raycast in 2D physics.

A raycast is used to detect objects that lie along the path of a ray and is conceptually like firing a laser beam into the Scene and observing which objects are hit by it. The RaycastHit2D class is used by Physics2D.Raycast and other functions to return information about the objects detected by raycasts.

See Also: Physics2D.Raycast, Ray2D class.

Properties

centroidThe centroid of the primitive used to perform the cast.
colliderThe collider hit by the ray.
distanceThe distance from the ray origin to the impact point.
fractionFraction of the distance along the ray that the hit occurred.
normalThe normal vector of the surface hit by the ray.
pointThe point in world space where the ray hit the collider's surface.
rigidbodyThe Rigidbody2D attached to the object that was hit.
transformThe Transform of the object that was hit.

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