Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

RaycastHit2D

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.

Variables

centroidThe centroid of the primitive used to perform the cast.
colliderThe collider hit by the ray.
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.