GetContactColliders
Retrieves all colliders in contact with this Collider, with the results filtered by the contactFilter.
Read time 1 minuteLast updated 5 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.Physics2DModule
GetContactColliders(Collider2D, ContactFilter2D, Allocator)
Retrieves all colliders in contact with this Collider, with the results filtered by the .
contactFilterpublic static ColliderArray2D GetContactColliders(Collider2D collider, ContactFilter2D contactFilter, Allocator allocator = Allocator.Temp)
Parameters
The Collider to retrieve contacts for.
The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.
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. |
GetContactColliders(Rigidbody2D, ContactFilter2D, Allocator)
Retrieves all colliders in contact with this Rigidbody, with the results filtered by the .
contactFilterpublic static ColliderArray2D GetContactColliders(Rigidbody2D rigidbody, ContactFilter2D contactFilter, Allocator allocator = Allocator.Temp)
Parameters
The Rigidbody to retrieve contacts for. All Colliders attached to this Rigidbody will be checked.
The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.
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. |