Version: Unity 6 (6000.0)
LanguageEnglish
  • C#

Rigidbody2D.SlideMovement.surfaceUp

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

public Vector2 surfaceUp;

Description

A reference direction used to calculate contact angles.

Both Rigidbody2D.SlideMovement.surfaceSlideAngle and Rigidbody2D.SlideMovement.gravitySlipAngle use this to determine the surface angle.

NOTE: By default, this value is Vector2.up. The magnitude of this vector is unimportant however an exception will be thrown in the magnitude is zero.

Additional resources: Rigidbody2D.Slide and SlideResults.