OverlapCollider
Gets a list of all Colliders that overlap the given Collider.
Read time 3 minutesLast updated 6 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.Physics2DModule
OverlapCollider(Collider2D, ContactFilter2D, Collider2D[])
Gets a list of all Colliders that overlap the given .
Colliderpublic static int OverlapCollider(Collider2D collider, ContactFilter2D contactFilter, Collider2D[] results)
Parameters
The Collider that defines the area used to query for other Collider overlaps.
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: Collider2D.Overlap and Rigidbody2D.Overlap.
OverlapCollider(Collider2D, ContactFilter2D, List<Collider2D>)
Gets a list of all Colliders that overlap the given .
Colliderpublic static int OverlapCollider(Collider2D collider, ContactFilter2D contactFilter, List<Collider2D> results)
Parameters
The Collider that defines the area used to query for other Collider overlaps.
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: Collider2D.Overlap and Rigidbody2D.Overlap.
OverlapCollider(Collider2D, ContactFilter2D, Allocator)
Gets a list of all Colliders that overlap the given .
Colliderpublic static ColliderArray2D OverlapCollider(Collider2D collider, ContactFilter2D contactFilter, Allocator allocator = Allocator.Temp)
Parameters
The Collider that defines the area used to query for other Collider overlaps.
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 memory allocator to use for the results. This can only be Allocator.Temp, Allocator.TempJob or Allocator.Persistent.
Returns
Type | Description |
|---|---|
| ColliderArray2D | A collection of Collider2D containing the results. The collection does not allocate any managed memory but must be disposed of. |
Remarks
This function returns a collection of Collider2D in a ColliderArray2D. The collection does not allocate any managed memory but must be disposed of.
The results can also be filtered by the .
contactFilterOverlapCollider(Vector2, float, Collider2D, ContactFilter2D, Allocator)
Gets a list of all Colliders that overlap the given .
Colliderpublic static ColliderArray2D OverlapCollider(Vector2 position, float angle, Collider2D collider, ContactFilter2D contactFilter, Allocator allocator = Allocator.Temp)
Parameters
The position at which to overlap the Collider.
The angle of at which to overlap the Collider (in degrees).
The Collider that defines the area used to query for other Collider overlaps.
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 memory allocator to use for the results. This can only be Allocator.Temp, Allocator.TempJob or Allocator.Persistent.
Returns
Type | Description |
|---|---|
| ColliderArray2D | A collection of Collider2D containing the results. The collection does not allocate any managed memory but must be disposed of. |
Remarks
This function returns a collection of Collider2D in a ColliderArray2D. The collection does not allocate any managed memory but must be disposed of.
The results can also be filtered by the .
contactFilter