Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

OverlapAreaAll(Vector2, Vector2, int, float, float)

Get a list of all Colliders that fall within a rectangular area.
Read time 1 minuteLast updated 6 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.Physics2DModule
public static Collider2D[] OverlapAreaAll(Vector2 pointA, Vector2 pointB, int layerMask, float minDepth, float maxDepth)

Parameters

pointA

Vector2
One corner of the rectangle.

pointB

Vector2
Diagonally opposite the point A corner of the rectangle.

layerMask

int
Filter to check objects only on specific layers.

minDepth

float
Only include objects with a Z coordinate (depth) greater than or equal to this value.

maxDepth

float
Only include objects with a Z coordinate (depth) less than or equal to this value.

Returns

Type

Description

Collider2D[]The cast results returned.

Remarks

This function is similar to Physics2D.OverlapArea except that all Colliders that fall within the area are returned. The Colliders in the returned array are sorted in order of increasing Z coordinate. An empty array is returned if there are no Colliders within the area.
Note that this function will allocate memory for the returned Collider2D array. You can use OverlapAreaNonAlloc to avoid this overhead if you need to make the check frequently.
Additional Resources: Physics2D.OverlapArea, OverlapAreaNonAlloc.