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.
CloseFor 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.
Closecontacts | An array of ContactPoint2D used to receive the results. |
int
Returns the number of contacts placed in the contacts
array.
Retrieves all contact points for this collider.
Contacts involving a Collider2D set to be a trigger will never be returned here as trigger colliders do not have contact points.
You should pass an array that is large enough to contain all the contacts you want returned. This array would typically be reused so it should be of a size that can return a reasonable quantity of contacts. No allocations occur in this function which means no work is produced for the garbage collector.
See Also: Rigidbody2D.GetContacts and Physics2D.GetContacts.
colliders | An array of Collider2D used to receive the results. |
int
Returns the number of contacts placed in the colliders
array.
Retrieves all colliders in contact with this collider.
You should pass an array that is large enough to contain all the contacts you want returned. This array would typically be reused so it should be of a size that can return a reasonable quantity of contacts. No allocations occur in this function which means no work is produced for the garbage collector.
See Also: Rigidbody2D.GetContacts and Physics2D.GetContacts.
contactFilter | The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. |
contacts | An array of ContactPoint2D used to receive the results. |
int
Returns the number of contacts placed in the contacts
array.
Retrieves all contact points for this collider, with the results filtered by the ContactFilter2D
.
Contacts involving a Collider2D set to be a trigger will never be returned here as trigger colliders do not have contact points. This is true even if the contactFilter
has its ContactFilter2D.useTriggers set to true.
You should pass an array that is large enough to contain all the contacts you want returned. This array would typically be reused so it should be of a size that can return a reasonable quantity of contacts. No allocations occur in this function which means no work is produced for the garbage collector.
See Also: Rigidbody2D.GetContacts and Physics2D.GetContacts.
contactFilter | The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. |
colliders | An array of Collider2D used to receive the results. |
int
Returns the number of collidersplaced in the colliders
array.
Retrieves all colliders in contact with this collider, with the results filtered by the ContactFilter2D
.
You should pass an array that is large enough to contain all the contacts you want returned. This array would typically be reused so it should be of a size that can return a reasonable quantity of contacts. No allocations occur in this function which means no work is produced for the garbage collector.
See Also: Rigidbody2D.GetContacts and Physics2D.GetContacts.
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:
Thanks for helping to make the Unity documentation better!