Collider2D.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:

• 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.forceSendLayers.