struct in UnityEngine
/
Implemented in:UnityEngine.Physics2DModule
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.
CloseFor 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.
CloseThe 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.
gravity | The gravity to be applied to the slide position. |
gravitySlipAngle | When the gravity movement causes a contact with a Collider2D, slippage maybe occur if the surface angle is greater than this angle. |
layerMask | A LayerMask that will be used when determining what Collider2D should be detected. |
maxIterations | Controls the maximum number of iterations to perform when determining how a Rigidbody2D will slide. |
selectedCollider | The specific Collider2D attached to this Rigidbody2D to be used to detect contacts. |
startPosition | The start position to slide the Rigidbody2D from. |
surfaceAnchor | The direction and distance to use when detecting if a surface is nearby during a slide iteration. |
surfaceSlideAngle | When the velocity movement causes a contact with a Collider2D, a slide maybe occur if the surface angle is less than this angle. |
surfaceUp | A reference direction used to calculate contact angles. |
useAttachedTriggers | Can be used to select whether any Collider2D attached to this Rigidbody2D (that are configured as a trigger) are used to detect contacts. |
useLayerMask | Whether the specified Rigidbody2D.SlideMovement.layerMask should be used or not when determining what Collider2D should be detected. |
useNoMove | Controls if any Rigidbody2D movement will happen or not. |
useSimulationMove | Controls whether the Rigidbody2D is instantly moved to the calculated position or is moved with Rigidbody2D.MovePosition. |
useStartPosition | Whether the specified Rigidbody2D.SlideMovement.startPosition should be used or not. |
SetLayerMask | A helper method that simultaneously sets both the Rigidbody2D.SlideMovement.layerMask to the specified mask but also sets Rigidbody2D.SlideMovement.useLayerMask to true. |
SetStartPosition | A helper method that simultaneously sets both the Rigidbody2D.SlideMovement.startPosition to the specified /position but also sets Rigidbody2D.SlideMovement.useStartPosition to true. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.