IsTouching
Check whether this collider is touching the collider or not.
Read time 2 minutesLast updated 8 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.Physics2DModule
IsTouching(Collider2D)
Check whether this collider is touching the or not.
colliderpublic bool IsTouching(Collider2D collider)
Parameters
The collider to check if it is touching this collider.
Returns
Type | Description |
|---|---|
| bool | Whether this collider is touching the |
Remarks
It is important to understand that checking whether colliders are touching or not is performed against the last physics system 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)
Check whether this collider is touching the or not with the results filtered by the .
collidercontactFilterpublic bool IsTouching(Collider2D collider, ContactFilter2D contactFilter)
Parameters
The collider to check if it is touching this collider.
The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.
Returns
Type | Description |
|---|---|
| bool | Whether this collider is touching the |
Remarks
It is important to understand that checking whether colliders are touching or not is performed against the last physics system 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(ContactFilter2D)
Check whether this collider is touching other colliders or not with the results filtered by the .
contactFilterpublic bool IsTouching(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 this collider is touching the |
Remarks
It is important to understand that checking whether colliders are touching or not is performed against the last physics system 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.