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 all of the Collider(s) attached to this Rigidbody.
Contacts involving a Collider2D set to be a trigger will never be returned here because trigger Colliders do not have contact points.
When retrieving contacts, you should ensure that the provided array is large enough to contain all the contacts you are interested in. Typically the array would be reused therefore it would be a size to return a reasonable quantity of contacts. This function also means that no allocations occur which means no work is produced for the garbage collector.
Additional resources: Collider2D.GetContacts and Physics2D.GetContacts.
colliders | An array of Collider2D used to receive the results. |
int
Returns the number of colliders placed in the colliders
array.
Retrieves all Colliders in contact with any of the Collider(s) attached to this Rigidbody.
When retrieving contacts, you should ensure that the provided array is large enough to contain all the contacts you are interested in. Typically the array would be reused therefore it would be a size to return a reasonable quantity of contacts. This function also means that no allocations occur which means no work is produced for the garbage collector.
Additional resources: Collider2D.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 all of the Collider(s) attached to this Rigidbody, with the results filtered by the ContactFilter2D
.
Contacts involving a Collider2D set to be a trigger will never be returned here because trigger Colliders do not have contact points. This is true even if the contactFilter
has its ContactFilter2D.useTriggers set to true.
When retrieving contacts, you should ensure that the provided array is large enough to contain all the contacts you are interested in. Typically the array would be reused therefore it would be a size to return a reasonable quantity of contacts. This function also means that no allocations occur which means no work is produced for the garbage collector.
Additional resources: Collider2D.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 colliders placed in the colliders
array.
Retrieves all Colliders in contact with any of the Collider(s) attached to this rigidbody, with the results filtered by the ContactFilter2D
.
When retrieving contacts, you should ensure that the provided array is large enough to contain all the contacts you are interested in. Typically the array would be reused therefore it would be a size to return a reasonable quantity of contacts. This function also means that no allocations occur which means no work is produced for the garbage collector.
Additional resources: Collider2D.GetContacts and Physics2D.GetContacts.
contacts | A list of ContactPoint2D used to receive the results. |
int
Returns the number of contacts placed in the contacts
list.
Retrieves all contact points for all of the Collider(s) attached to this Rigidbody.
Contacts involving a Collider2D set to be a trigger will never be returned here because trigger Colliders do not have contact points.
The integer return value is the number of results written into the contacts
list. The contacts list will be resized if it doesn't contain enough elements to report all the results. This prevents memory from being allocated for results when the contacts
list does not need to be resized, and improves garbage collection performance when the query is performed frequently.
Additional resources: Collider2D.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 | A list of ContactPoint2D used to receive the results. |
int
Returns the number of contacts placed in the contacts
list.
Retrieves all contact points for all of the Collider(s) attached to this Rigidbody.
Contacts involving a Collider2D set to be a trigger will never be returned here because trigger Colliders do not have contact points.
The integer return value is the number of results written into the contacts
list. The contacts list will be resized if it doesn't contain enough elements to report all the results. This prevents memory from being allocated for results when the contacts
list does not need to be resized, and improves garbage collection performance when the query is performed frequently.
The results can also be filtered by the contactFilter
.
Additional resources: Collider2D.GetContacts and Physics2D.GetContacts.
colliders | A list of Collider2D used to receive the results. |
int
Returns the number of Colliders placed in the colliders
list.
Retrieves all Colliders in contact with any of the Collider(s) attached to this Rigidbody.
The integer return value is the number of results written into the colliders
list. The contacts list will be resized if it doesn't contain enough elements to report all the results.This prevents memory from being allocated for results when the colliders
list does not need to be resized, and improves garbage collection performance when the query is performed frequently.
Additional resources: Collider2D.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 | A list of Collider2D used to receive the results. |
int
Returns the number of Colliders placed in the colliders
list.
Retrieves all Colliders in contact with any of the Collider(s) attached to this Rigidbody.
The integer return value is the number of results written into the colliders
list. The contacts list will be resized if it doesn't contain enough elements to report all the results. This prevents memory from being allocated for results when the colliders
list does not need to be resized, and improves garbage collection performance when the query is performed frequently.
The results can also be filtered by the contactFilter
.
Additional resources: Collider2D.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:
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.