Version: 2020.1
LanguageEnglish
  • C#

Physics2D.IgnoreCollision

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 void IgnoreCollision(Collider2D collider1, Collider2D collider2, bool ignore = true);

Parameters

collider1 The first collider to compare to collider2.
collider2 The second collider to compare to collider1.
ignore Whether collisions/triggers between collider1 and collider2 should be ignored or not.

Description

Makes the collision detection system ignore all collisions/triggers between collider1 and collider2.

Ignoring collisions refers to any type of interaction between the selected colliders i.e. no collision or trigger interaction will occur. Collision layers are first checked to see the two layers can interact and if not then no interactions take place. Following that, ignoring specific colliders interactions will occur.

IgnoreCollision has a few limitations: 1) It is not persistent. This means that the ignore collision state will not be stored in the editor when saving a Scene. 2) You can only apply the ignore collision to colliders in active game objects. When deactivating the collider the IgnoreCollision state will be lost and you have to call Physics2D.IgnoreCollision again. See Also: Physics2D.GetIgnoreCollision, Physics2D.IgnoreLayerCollision.

using UnityEngine;

public class Example : MonoBehaviour { // Instantiate a bullet and make it ignore collisions with this object.

Transform bulletPrefab;

void Start() { var bullet = Instantiate(bulletPrefab) as Transform; Physics2D.IgnoreCollision(bullet.GetComponent<Collider2D>(), GetComponent<Collider2D>()); } }

Did you find this page useful? Please give it a rating: