Unity - Scripting API: Rigidbody2D.Overlap
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.
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.
Declaration
public int Overlap(Vector2 position, float angle, List<Collider2D> results);
Parameters
| Parameter | Description |
|---|---|
| position | The position to overlap the Rigidbody at. |
| angle | The angle to overlap the Rigidbody at. |
| results | The 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 all Colliders attached to this Rigidbody2D.
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: Physics2D.OverlapCollider, Collider2D.Overlap and Rigidbody2D.GetAttachedColliders.
Declaration
public int Overlap(Vector2 position, float angle, ContactFilter2D contactFilter, List<Collider2D> results);
Parameters
| Parameter | Description |
|---|---|
| position | The position to overlapping the Rigidbody at. |
| angle | The angle to overlap the Rigidbody at. |
| 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 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 all Colliders attached to this Rigidbody2D.
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: Physics2D.OverlapCollider, Collider2D.Overlap and Rigidbody2D.GetAttachedColliders.
Declaration
public int Overlap(List<Collider2D> results);
Parameters
| Parameter | Description |
|---|---|
| results | The 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 all Colliders attached to this Rigidbody2D.
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: Physics2D.OverlapCollider, Collider2D.Overlap and Rigidbody2D.GetAttachedColliders.
Declaration
public int Overlap(ContactFilter2D contactFilter, List<Collider2D> results);
Parameters
| Parameter | Description |
|---|---|
| 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 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 all Colliders attached to this Rigidbody2D filtered by the contactFilter.
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: Physics2D.OverlapCollider, Collider2D.Overlap and Rigidbody2D.GetAttachedColliders.
Declaration
public int Overlap(ContactFilter2D contactFilter, out Collider2D[] results);
Parameters
| Parameter | Description |
|---|---|
| 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. |
Returns
int
Returns the number of results placed in the results array.
Description
Get a list of all Colliders that overlap all Colliders attached to this Rigidbody2D filtered by the contactFilter.
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.
Additional resources: Physics2D.OverlapCollider, Collider2D.Overlap and Rigidbody2D.GetAttachedColliders.