Legacy Documentation: Version 2017.1 (Go to current version)
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.


Suggest a change


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.


Submission failed

For 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.



Switch to Manual
public function OverlapCollider(contactFilter: ContactFilter2D, results: Collider2D[]): int;
public int OverlapCollider(ContactFilter2D contactFilter, Collider2D[] results);


contactFilter The contact filter used to filter the results differently, such as by layer mask, Z depth. Note that normal angle is not used for overlap testing.
results The array to receive results. The size of the array determines the maximum number of results that can be returned.


int Returns the number of results placed in the results array.


Get a list of all colliders that overlap all colliders attached to this Rigidbody2D.

The integer return value is the number of colliders that overlap the collider and which could be stored in the supplied array given its length. The results array will not be resized if it doesn't contain enough elements to report all the results. The significance of this is that no memory is allocated for the results and so garbage collection performance is improved when the check is performed frequently.

See Also: Physics2D.OverlapCollider, Collider2D.OverlapCollider & Rigidbody2D.GetAttachedColliders.

Did you find this page useful? Please give it a rating: