Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

OverlapPointAll(Vector2, int, float, float)

Get a list of all Colliders that overlap a point in space.
Read time 1 minuteLast updated 4 days ago

Definition

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

Parameters

point

Vector2
A point in space.

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.OverlapPoint except that all Colliders that overlap the point 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 over the point.
Note that this function will allocate memory for the returned Collider2D array. You can use OverlapPointNonAlloc to avoid this overhead if you need to make the check frequently.
Additional Resources: Physics2D.OverlapPoint, OverlapPointNonAlloc.