Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

Collider2D.forceReceiveLayers

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 LayerMask forceReceiveLayers;

Description

The Layers that this Collider2D can receive forces from during a Collision contact with another Collider2D.

When a collision occurs between two Collider2D, both Colliders would normally receive a force from each other that separates them. Both Colliders have a Layer assigned to them respectively, which can be the same or different Layer(s). For the forces to apply, each Collider must send a force to the Layer that is assigned to the other Collider, while also receiving a force on their own Layer from the other Collider. Thus, both Colliders must mutually agree on which Layers the forces are being sent and received.

The forceReceiveLayers property allows you to select which Layers that the Collider receives force from, while forceSendLayers allows you to select which Layers the Collider sends a force to.

NOTES:

Additional resources: Collider2D.forceSendLayers.