Version: 5.4 beta (switch to 5.3)
LanguageEnglish
  • C#
  • JS

Script language

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

Physics2D.OverlapBoxAll

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

Sumbission failed

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

Close

Cancel

public static function OverlapBoxAll(point: Vector2, size: Vector2, angle: float, layerMask: int = DefaultRaycastLayers, minDepth: float = -Mathf.Infinity, maxDepth: float = Mathf.Infinity): Collider2D[];
public static Collider2D[] OverlapBoxAll(Vector2 point, Vector2 size, float angle, int layerMask = DefaultRaycastLayers, float minDepth = -Mathf.Infinity, float maxDepth = Mathf.Infinity);

Parameters

point Center of the box.
size Size of the box.
angle Angle of the box.
layerMask Filter to check objects only on specific layers.
minDepth Only include objects with a Z coordinate (depth) greater than this value.
maxDepth Only include objects with a Z coordinate (depth) less than this value.

Description

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

This function is similar to OverlapBox except that all colliders that fall within the box 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 box.

Note that this function will allocate memory for the returned Collider2D array. You can use OverlapBoxNonAlloc to avoid this overhead if you need to make the check frequently.

See Also: OverlapBox, OverlapBoxNonAlloc.

Copyright © 2016 Unity Technologies. Publication 5.4b-R
Tutorials Community Answers Knowledge Base Forums Asset Store