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.

Collider2D.OnTriggerEnter2D(Collider2D)

Switch to Manual

Description

Sent when another object enters a trigger collider attached to this object (2D physics only).

Further information about the other collider is reported in the Collider2D parameter passed during the call.

See Also: Collider2D class, OnTriggerExit2D, OnTriggerStay2D.

var characterInQuicksand: boolean;

function OnTriggerEnter2D(other: Collider2D) { characterInQuicksand = true; }

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public bool characterInQuicksand;
    void OnTriggerEnter2D(Collider2D other) {
        characterInQuicksand = true;
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public characterInQuicksand as bool

	def OnTriggerEnter2D(other as Collider2D) as void:
		characterInQuicksand = true