Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

Physics2D.IgnoreCollision

static function IgnoreCollision(collider1: Collider2D, collider2: Collider2D, ignore: bool = true): void;
static void IgnoreCollision(Collider2D collider1, Collider2D collider2, bool ignore = true);
static def IgnoreCollision(collider1 as Collider2D, collider2 as Collider2D, ignore as bool = true) as void

Parameters

collider1The first collider to compare to collider2.
collider2The second collider to compare to collider1.
ignoreWhether 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.

	// Instantiate a bullet and make it ignore collisions with this object.
	var bulletPrefab : Transform;
	function Start () {
		var bullet = Instantiate(bulletPrefab) as Transform;
		Physics2D.IgnoreCollision(bullet.collider2D, collider2D);
	}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public Transform bulletPrefab;
    void Start() {
        Transform bullet = Instantiate(bulletPrefab) as Transform;
        Physics2D.IgnoreCollision(bullet.collider2D, collider2D);
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public bulletPrefab as Transform

	def Start() as void:
		bullet as Transform = (Instantiate(bulletPrefab) as Transform)
		Physics2D.IgnoreCollision(bullet.collider2D, collider2D)