Version: Unity 6 (6000.0)
LanguageEnglish
  • C#

Rigidbody2D.SlideMovement.useLayerMask

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 bool useLayerMask;

Description

Whether the specified Rigidbody2D.SlideMovement.layerMask should be used or not when determining what Collider2D should be detected.

When false, the layers already associated with the Collider2D attached to the Rigidbody2D will be used along with the Layer Collision Matrix configuration to determine which Collider2D will be detected.

When true, the specified Rigidbody2D.SlideMovement.layerMask will be used to determine which Collider2D will be detected and any Layer Collision Matrix configuration will be ignored.

Additional resources: Rigidbody2D.SlideMovement.layerMask, Rigidbody2D.Slide and SlideResults.