Overlap
Get a list of all Colliders that overlap all Colliders attached to this Rigidbody2D filtered by the contactFilter.
Read time 4 minutesLast updated 4 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.Physics2DModule
Overlap(ContactFilter2D, Collider2D[])
Get a list of all Colliders that overlap all Colliders attached to this Rigidbody2D filtered by the .
contactFilterpublic int Overlap(ContactFilter2D contactFilter, Collider2D[] results)
Parameters
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.
The array to receive results. The size of the array determines the maximum number of results that can be returned.
Returns
Type | Description |
|---|---|
| int | Returns the number of results placed in the |
Remarks
The integer return value is the number of Colliders that overlap the 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.
colliderAdditional Resources: Physics2D.OverlapCollider, Collider2D.Overlap, Rigidbody2D.GetAttachedColliders
Overlap(List<Collider2D>)
Get a list of all Colliders that overlap all Colliders attached to this Rigidbody2D.
public int Overlap(List<Collider2D> results)
Parameters
The list to receive results.
Returns
Type | Description |
|---|---|
| int | Returns the number of results placed in the |
Remarks
The integer return value is the number of results written into the 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 list does not need to be resized, and improves garbage collection performance when the query is performed frequently.
resultsresultsAdditional Resources: Physics2D.OverlapCollider, Collider2D.Overlap, Rigidbody2D.GetAttachedColliders
Overlap(ContactFilter2D, List<Collider2D>)
Get a list of all Colliders that overlap all Colliders attached to this Rigidbody2D filtered by the .
contactFilterpublic int Overlap(ContactFilter2D contactFilter, List<Collider2D> results)
Parameters
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.
The list to receive results.
Returns
Type | Description |
|---|---|
| int | Returns the number of results placed in the |
Remarks
The integer return value is the number of results written into the 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 list does not need to be resized, and improves garbage collection performance when the query is performed frequently.
resultsresultsAdditional Resources: Physics2D.OverlapCollider, Collider2D.Overlap, Rigidbody2D.GetAttachedColliders
Overlap(Vector2, float, List<Collider2D>)
Get a list of all Colliders that overlap all Colliders attached to this Rigidbody2D.
public int Overlap(Vector2 position, float angle, List<Collider2D> results)
Parameters
The position to overlap the Rigidbody at.
The angle to overlap the Rigidbody at.
The list to receive results.
Returns
Type | Description |
|---|---|
| int | Returns the number of results placed in the |
Remarks
The integer return value is the number of results written into the 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 list does not need to be resized, and improves garbage collection performance when the query is performed frequently.
resultsresultsAdditional Resources: Physics2D.OverlapCollider, Collider2D.Overlap, Rigidbody2D.GetAttachedColliders
Overlap(Vector2, float, ContactFilter2D, List<Collider2D>)
Get a list of all Colliders that overlap all Colliders attached to this Rigidbody2D.
public int Overlap(Vector2 position, float angle, ContactFilter2D contactFilter, List<Collider2D> results)
Parameters
The position to overlapping the Rigidbody at.
The angle to overlap the Rigidbody at.
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.
The list to receive results.
Returns
Type | Description |
|---|---|
| int | Returns the number of results placed in the |
Remarks
The integer return value is the number of results written into the 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 list does not need to be resized, and improves garbage collection performance when the query is performed frequently.
resultsresultsAdditional Resources: Physics2D.OverlapCollider, Collider2D.Overlap, Rigidbody2D.GetAttachedColliders