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.
Closeresults | An array of Collider2D used to receive the results. |
findTriggers | Whether Collider2D that are triggers should be returned or not. |
int
Returns the number of Collider2D placed in the results
array.
Returns all Collider2D that are attached to this Rigidbody2D.
Calculates all Collider2D that are attached to this Rigidbody2D and returns them in the results
array.
When retrieving colliders, you should ensure that the provided array is large enough to contain all the colliders you are interested in. Typically the array would be reused therefore it would be a size to return a reasonable quantity of colliders. This function also means that no allocations occur which means no work is produced for the garbage collector.
Additional resources: Rigidbody2D.attachedColliderCount.
results | A list of Collider2D used to receive the results. |
findTriggers | Whether Collider2D that are triggers should be returned or not. |
int
Returns the number of Collider2D placed in the results
list.
Returns all Collider2D that are attached to this Rigidbody2D.
Calculates all Collider2D that are attached to this Rigidbody2D and returns them in the results
list.
The integer return value is the number of results written into the results
list. The results 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 results
list does not need to be resized, and improves garbage collection performance when the query is performed frequently.
Additional resources: Rigidbody2D.attachedColliderCount.
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.