Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


surfaceHit

The specific contact found when a slide movement is performed with Rigidbody2D.Slide.
Read time 1 minuteLast updated 10 days ago

Definition

  • Type: Property
  • Namespace: UnityEngine
  • Assembly: UnityEngine.Physics2DModule
public RaycastHit2D surfaceHit { readonly get; set; }

Remarks

When a slide along a surface occurs, a surface contact will be detected either from using a _surfaceAnchor or using _gravityScale.
In short, if the movement anchors to a surface or if gravity causes a contact with the surface, this RaycastHit2D represents that contact.
NOTE: This contact does not necessarily represent the surface that movement is tangent to. That is represented by _slideHit.