CollisionEvents2D Class

Summary

Holds UltEvents.UltEvents which are called by various MonoBehaviour 2D collision events: UltEvents.CollisionEvents2D.OnCollisionEnter2D(Collision2D), UltEvents.CollisionEvents2D.OnCollisionStay2D(Collision2D), and UltEvents.CollisionEvents2D.OnCollisionExit2D(Collision2D).
Assembly
UltEvents.dll
Namespace
UltEvents
Base Types
  • MonoBehaviour
graph BT Type-->Base0["MonoBehaviour"] Type["CollisionEvents2D"] class Type type-node

Syntax

[AddComponentMenu(UltEventUtils.ComponentMenuPrefix + "Collision Events 2D")]
[DisallowMultipleComponent]
[RequireComponent(typeof(Collider2D))]
[UltEventsHelpUrl(typeof(CollisionEvents2D))]
public class CollisionEvents2D : MonoBehaviour

Attributes

Type Description
AddComponentMenu
DisallowMultipleComponent
RequireComponent
UltEventsHelpUrlAttribute [Assert-Conditional] A HelpURLAttribute which points to the UltEvents documentation.

Properties

Name Value Summary
CollisionEnterEvent UltEvent<Collision2D>
Invoked by UltEvents.CollisionEvents2D.OnCollisionEnter2D(Collision2D).
CollisionExitEvent UltEvent<Collision2D>
Invoked by UltEvents.CollisionEvents2D.OnCollisionExit2D(Collision2D).
CollisionStayEvent UltEvent<Collision2D>
Invoked by UltEvents.CollisionEvents2D.OnCollisionStay2D(Collision2D).

Methods

Name Value Summary
OnCollisionEnter2D(Collision2D) void
Invokes UltEvents.CollisionEvents2D.CollisionEnterEvent.
OnCollisionExit2D(Collision2D) void
Invokes UltEvents.CollisionEvents2D.CollisionExitEvent.
OnCollisionStay2D(Collision2D) void
Invokes UltEvents.CollisionEvents2D.CollisionStayEvent.