Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


gravity

The gravity to be applied to the slide position.
Read time 1 minuteLast updated 13 days ago

Definition

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

Remarks

In a similar way to how the Physics2D.gravity works, the gravity vector here is scaled by time and applied as movement to the slide position. However, unlike Physics2D.gravity, this has no way of increasing the velocity to produce an acceleration so if this is required then this should be maintained and the current accumulated gravity velocity passed in. The reason that gravity is separated from the provided
velocity
is that it has a different behaviour in that it can produce slippage on surfaces where the angle is higher than Rigidbody2D.SlideMovement.gravitySlipAngle.
NOTE: By default this is (0, -9.81). Using Vector2.zero results in no gravity being applied.
Additional Resources: Rigidbody2D.Slide and Rigidbody2D.SlideResults.