Legacy Documentation: Version 2018.2 (Go to current version)
LanguageEnglish
  • C#

Physics2D.OverlapCircle

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static Collider2D OverlapCircle(Vector2 point, float radius, int layerMask = DefaultRaycastLayers, float minDepth = -Mathf.Infinity, float maxDepth = Mathf.Infinity);

Parameters

pointCentre of the circle.
radiusRadius of the circle.
layerMaskFilter to check objects only on specific layers.
minDepthOnly include objects with a Z coordinate (depth) greater than or equal to this value.
maxDepthOnly include objects with a Z coordinate (depth) less than or equal to this value.

Returns

Collider2D The collider overlapping the circle.

Description

Checks if a collider falls within a circular area.

The circle is defined by its centre coordinate in world space and by its radius. The optional layerMask allows the test to check only for objects on specific layers.

Although the Z axis is not relevant for rendering or collisions in 2D, you can use the minDepth and maxDepth parameters to filter objects based on their Z coordinate. If more than one collider falls within the circle then the one returned will be the one with the lowest Z coordinate value. Null is returned if there are no colliders in the circle. See Also: OverlapCircleAll, OverlapCircleNonAlloc.


public static int OverlapCircle(Vector2 point, float radius, ContactFilter2D contactFilter, Collider2D[] results);

Parameters

pointCentre of the circle.
radiusRadius of the circle.
contactFilterThe contact filter used to filter the results differently, such as by layer mask, Z depth. Note that normal angle is not used for overlap testing.
resultsThe array to receive results. The size of the array determines the maximum number of results that can be returned.

Returns

int Returns the number of results placed in the results array.

Description

Checks if a collider is within a circular area.

The circle is defined by its centre coordinate in world space and by its radius.

This function returns the number of colliders found and places those colliders in the results array. The results can also be filtered by the contactFilter. Note that filtering by normal angle is not available for overlap functions.

Did you find this page useful? Please give it a rating: