The Layers that this Collider2D is allowed to send forces to during a Collision contact with another Collider2D.
When a collision occurs between two Collider2D, both Colliders would normally apply a force to 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 forceSendLayers property allows you to select which Layers that the Collider sends a force to, while forceReceiveLayers allows you to select which Layers the Collider receives a force from.
NOTES:
Because forces only relate to a Collision contact, this features does not apply when either Collider2D is set to be a trigger via Collider2D.isTrigger and does not affect mutual forces applied by a Joint2D.
Any Rigidbody2D.bodyType can send forces; however, only a Dynamic Body Type can receive forces. Neither Kinematic Body Type nor Static Body Type can receive forces.
Forces being sent and received do not affect Collision callbacks which are still called even if no forces are applied.
During a Collision callback, any impulses reported by ContactPoint2D.normalImpulse or ContactPoint2D.tangentImpulse will be the impulses that would have been applied if forceSendLayers and forceReceiveLayers were not used.
See Also: Collider2D.forceReceiveLayers.
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.