Legacy Documentation: Version 5.1
LanguageEnglish
  • C#
  • JS

Script language

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

Rigidbody2D.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

Sumbission failed

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

Close

Cancel

Switch to Manual
public function IsTouchingLayers(layerMask: int = Physics2D.AllLayers): bool;
public bool IsTouchingLayers(int layerMask = Physics2D.AllLayers);

Parameters

layerMask Any colliders on any of these layers count as touching.

Returns

bool Whether any of the collider(s) attached to this rigidbody are touching any colliders on the specified layerMask or not.

Description

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

Copyright © 2015 Unity Technologies
Learn Community Asset Store Buy Download