Version: 2019.4
LanguageEnglish
  • C#

Physics2D.OverlapCircleNonAlloc

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 int OverlapCircleNonAlloc(Vector2 point, float radius, Collider2D[] results, int layerMask = DefaultRaycastLayers, float minDepth = -Mathf.Infinity, float maxDepth = Mathf.Infinity);

Parameters

pointThe center of the circle.
radiusThe radius of the circle.
resultsArray to receive results.
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

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

Description

Get a list of all colliders that fall within a circular area.

This function is similar to OverlapCircleAll except that the results are returned in the supplied array. The integer return value is the number of objects that fall within the circle and which could be stored in the supplied array given its length. The results array will not be resized if it doesn't contain enough elements to report all the results. The significance of this is that no memory is allocated for the results and so garbage collection performance is improved when the check is performed frequently.

See Also: OverlapCircle, OverlapCircleAll.