A decision priority assigned to this Collider2D used when there is a conflicting decision on whether a contact between itself and another Collision2D should happen or not.
The Layer Collision Matrix defines which Layers can and cannot contact other Layers. Addition Layer includes and excludes can be made per Collider2D or all Collider2D attached to a specific Rigidbody2D. Any contact involves two different Collider2D instances. Unfortunately this can result in one Collider2D deciding that it should contact the other Collider2D but the other Collider2D deciding it should not. There are rules however in determining and ultimately arbitrating the final decision on whether a contact should be created or not.
The rules for a making a decision for contact between two Collider2D, referred to here as A and B, are made in the following order:
If both A and B make the same decision then use that decision.
If only A or B are using a Layer include or exclude then use the decision for A or B that has include or exclude specified.
If both A and B are using a Layer include or exclude then use the decision from A or B that has the higher Collider2D.layerOverridePriority.
If A and B have the same Collider2D.layerOverridePriority then the decision will be to not create a contact.
Additional resources: Collider2D.includeLayers, Collider2D.excludeLayers, Rigidbody2D.includeLayers & Rigidbody2D.excludeLayers.
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.