Version: 5.5 (switch to 5.6b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Physics2D.IsTouchingLayers

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

public static function IsTouchingLayers(collider: Collider2D, layerMask: int = AllLayers): bool;
public static bool IsTouchingLayers(Collider2D collider, int layerMask = AllLayers);

Parameters

collider The collider to check if it is touching colliders on the layerMask.
layerMask Any colliders on any of these layers count as touching.

Returns

bool Whether the collider is touching any colliders on the specified layerMask or not.

Description

Checks whether the collider is touching any colliders on the specified layerMask or not.

It is important to understand that checking if colliders are touching or not is performed against the last physics system update i.e. 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. The touching state is identical to that indicated by the physics collision or trigger callbacks.