Version: 2021.3
LanguageEnglish
  • C#

Collider2D.IsTouching

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public bool IsTouching(Collider2D collider);

Parameters

collider The collider to check if it is touching this collider.

Returns

bool Whether this collider is touching the collider or not.

Description

Check whether this collider is touching the collider or not.

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.


Declaration

public bool IsTouching(Collider2D collider, ContactFilter2D contactFilter);

Parameters

collider The collider to check if it is touching this collider.
contactFilter The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.

Returns

bool Whether this collider is touching the collider or not.

Description

Check whether this collider is touching the collider or not with the results filtered by the contactFilter.

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.


Declaration

public bool IsTouching(ContactFilter2D contactFilter);

Parameters

contactFilter The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.

Returns

bool Whether this collider is touching the collider or not.

Description

Check whether this collider is touching other colliders or not with the results filtered by the contactFilter.

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.