Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


IsTouchingLayers(Collider2D, int)

Checks whether the Collider is touching any Colliders on the specified layerMask or not.
Read time 1 minuteLast updated 8 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.Physics2DModule
public static bool IsTouchingLayers(Collider2D collider, int layerMask)

Parameters

collider


layerMask

Any Colliders on any of these layers count as touching.

Returns

Type

Description

boolWhether the
Collider
is touching any Colliders on the specified
layerMask
or not.

Remarks

It is important to understand that checking if Colliders are touching or not is performed against the last physics engine 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.