Version: 2023.2
LanguageEnglish
  • C#

SlideMovement

struct in UnityEngine

/

Implemented in:UnityEngine.Physics2DModule

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

Switch to Manual

Description

The configuration that controls how a Rigidbody2D.Slide method behaves.

NOTE: This struct can be used in the Unity Inspector for configuration purposes.

Additional resources: Rigidbody2D.Slide and SlideResults.

Properties

gravityThe gravity to be applied to the slide position.
gravitySlipAngleWhen the gravity movement causes a contact with a Collider2D, slippage maybe occur if the surface angle is greater than this angle.
layerMaskA LayerMask that will be used when determining what Collider2D should be detected.
maxIterationsControls the maximum number of iterations to perform when determining how a Rigidbody2D will slide.
selectedColliderThe specific Collider2D attached to this Rigidbody2D to be used to detect contacts.
startPositionThe start position to slide the Rigidbody2D from.
surfaceAnchorThe direction and distance to use when detecting if a surface is nearby during a slide iteration.
surfaceSlideAngleWhen the velocity movement causes a contact with a Collider2D, a slide maybe occur if the surface angle is less than this angle.
surfaceUpA reference direction used to calculate contact angles.
useAttachedTriggersCan be used to select whether any Collider2D attached to this Rigidbody2D (that are configured as a trigger) are used to detect contacts.
useLayerMaskWhether the specified Rigidbody2D.SlideMovement.layerMask should be used or not when determining what Collider2D should be detected.
useNoMoveControls if any Rigidbody2D movement will happen or not.
useSimulationMoveControls whether the Rigidbody2D is instantly moved to the calculated position or is moved with Rigidbody2D.MovePosition.
useStartPositionWhether the specified Rigidbody2D.SlideMovement.startPosition should be used or not.

Public Methods

SetLayerMaskA helper method that simultaneously sets both the Rigidbody2D.SlideMovement.layerMask to the specified mask but also sets Rigidbody2D.SlideMovement.useLayerMask to true.
SetStartPositionA helper method that simultaneously sets both the Rigidbody2D.SlideMovement.startPosition to the specified /position but also sets Rigidbody2D.SlideMovement.useStartPosition to true.