Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


reuseCollisionCallbacks

Determines whether the garbage collector should reuse only a single instance of a Collision2D type for all collision callbacks.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Property
  • Namespace: UnityEngine
  • Assembly: UnityEngine.Physics2DModule
public static bool reuseCollisionCallbacks { get; set; }

Remarks

When an
OnCollisionEnter2D
,
OnCollisionStay2D
or
OnCollisionExit2D
collision callback occurs, the Collision2D object passed to it is created for each individual callback. This means the garbage collector has to remove each object, which reduces performance.
When this option is true, only a single instance of the Collision2D type is created and reused for each individual callback. This reduces waste for the garbage collector to handle and improves performance.
You would only set this option to false if the Collision2D object is referenced outside of the collision callback for processing later, so recycling the Collision2D object is not required.