Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

OverlapCircleAll(Vector2, float, int, float, float)

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

Definition

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

Parameters

point

Vector2
The center of the circle.

radius

float
The radius of the circle.

layerMask

int
Filter to check objects only on specified 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.

Remarks

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