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

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Physics2D.OverlapBoxNonAlloc

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 method OverlapBoxNonAlloc(point: Vector2, size: Vector2, angle: float, results: Collider2D[], layerMask: int = DefaultRaycastLayers, minDepth: float = -Mathf.Infinity, maxDepth: float = Mathf.Infinity): int;
public static int OverlapBoxNonAlloc(Vector2 point, Vector2 size, float angle, Collider2D[] results, int layerMask = DefaultRaycastLayers, float minDepth = -Mathf.Infinity, float maxDepth = Mathf.Infinity);

Parameters

pointCenter of the box.
sizeSize of the box.
angleAngle of the box.
resultsArray to receive results.
layerMaskFilter to check objects only on specific layers.
minDepthOnly include objects with a Z coordinate (depth) greater than this value.
maxDepthOnly include objects with a Z coordinate (depth) less than 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 box area.

This function is similar to OverlapBoxAll except that the results are returned in the supplied array. The integer return value is the number of objects that fall within the box (possibly zero) but 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: OverlapBox, OverlapBoxAll.

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