IsTouching
Checks whether the passed Colliders are in contact or not.
Read time 2 minutesLast updated 6 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.Physics2DModule
IsTouching(Collider2D, Collider2D)
Checks whether the passed Colliders are in contact or not.
public static bool IsTouching(Collider2D collider1, Collider2D collider2)
Parameters
The Collider to check if it is touching .
collider2The Collider to check if it is touching .
collider1Returns
Type | Description |
|---|---|
| bool | Whether |
Remarks
It is important to understand that checking whether Colliders are touching or not is performed against the last physics engine update; that is the state of touching Colliders at that time. If you have just added a new Collider2D or have moved a Collider2D but a physics update has not yet taken place then the Colliders will not be shown as touching. This function returns the same collision results as the physics collision or trigger callbacks.
IsTouching(Collider2D, Collider2D, ContactFilter2D)
Checks whether the passed Colliders are in contact or not.
public static bool IsTouching(Collider2D collider1, Collider2D collider2, ContactFilter2D contactFilter)
Parameters
The Collider to check if it is touching .
collider2The Collider to check if it is touching .
collider1The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.
Returns
Type | Description |
|---|---|
| bool | Whether |
Remarks
It is important to understand that checking whether Colliders are touching or not is performed against the last physics engine update; that is the state of touching Colliders at that time. If you have just added a new Collider2D or have moved a Collider2D but a physics update has not yet taken place then the Colliders will not be shown as touching. This function returns the same collision results as the physics collision or trigger callbacks.
IsTouching(Collider2D, ContactFilter2D)
Checks whether the passed Colliders are in contact or not.
public static bool IsTouching(Collider2D collider, ContactFilter2D contactFilter)
Parameters
The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.
Returns
Type | Description |
|---|---|
| bool | Whether the |
Remarks
It is important to understand that checking whether Colliders are touching or not is performed against the last physics engine update; that is the state of touching Colliders at that time. If you have just added a new Collider2D or have moved a Collider2D but a physics update has not yet taken place then the Colliders will not be shown as touching. This function returns the same collision results as the physics collision or trigger callbacks.