Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


IsTouchingLayers(int)

Checks whether any of the collider(s) attached to this rigidbody are touching any colliders on the specified layerMask or not.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.Physics2DModule
public bool IsTouchingLayers(int layerMask = -1)

Parameters

layerMask

Any colliders on any of these layers count as touching.

Returns

Type

Description

boolWhether any of the collider(s) attached to this rigidbody are 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 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.