Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

OverlapBoxAll(Vector2, Vector2, float, int, float, float)

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

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.Physics2DModule
public static Collider2D[] OverlapBoxAll(Vector2 point, Vector2 size, float angle, int layerMask, float minDepth, float maxDepth)

Parameters

point

Vector2
The center of the box.

size

Vector2
The size of the box.

angle

float
The angle of the box.

layerMask

int
Filter to check objects only on specific layers.

minDepth

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

maxDepth

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

Returns

Type

Description

Collider2D[]The cast results returned.

Remarks

This function is similar to Physics2D.OverlapBox except that all Colliders that fall within the box 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 box.
Note that this function will allocate memory for the returned Collider2D array. You can use OverlapBoxNonAlloc to avoid this overhead if you need to make the check frequently.
Additional Resources: Physics2D.OverlapBox, OverlapBoxNonAlloc.