Version: 2019.1 (switch to 2018.4
LanguageEnglish
  • C#

Collider2D.OverlapCollider

Suggest a change

Success!

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.

Close

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.

Close

Cancel

public int OverlapCollider(ContactFilter2D contactFilter, Collider2D[] results);

Parameters

contactFilterThe 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.
resultsThe array to receive results. The size of the array determines the maximum number of results that can be returned.

Returns

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

Description

Get a list of all colliders that overlap this collider.

The integer return value is the number of colliders that overlap this 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 query is performed frequently.

See Also: Physics2D.OverlapCollider & Rigidbody2D.OverlapCollider.


public int OverlapCollider(ContactFilter2D contactFilter, List<Collider2D> results);

Parameters

contactFilterThe 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.
resultsThe list to receive results.

Returns

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

Description

Get a list of all Colliders that overlap this Collider.

The integer return value is the number of Colliders that overlap this Collider with the specific Colliders stored in the supplied list. The results array will not be resized if it doesn't contain enough elements to report all the results. 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.

See Also: Physics2D.OverlapCollider & Rigidbody2D.OverlapCollider.

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