Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • 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

centroid The centroid of the primitive used to perform the cast.
collider The collider hit by the ray.
distance The distance from the ray's origin to the impact point.
fraction Fraction of the distance along the ray that the hit occurred.
normal The normal vector of the surface hit by the ray.
point The point in world space where the ray hit the collider's surface.
rigidbody The Rigidbody2D attached to the object that was hit.
transform The Transform of the object that was hit.