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

Parámetros

pointThe center of the box.
sizeThe size of the box.
angleThe angle of the box.
layerMaskFiltro para revisar objetos solamente en capas especificas.
minDepthSolamente incluye objetos con una coordenada Z (profundidad) mayor que este valor.
maxDepthSolamente incluye objetos con una coordenada Z (profundidad) menor que este valor.

Valor de retorno

Collider2D The collider overlapping the box.

Descripción

Checks if a collider falls within a box area.

The box is defined by its center coordinate in world space and by its size. 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 box then the one returned will be the one with the lowest Z coordinate value. Null is returned if there are no colliders in the box.

See Also: OverlapBoxAll, OverlapBoxNonAlloc.


public static int OverlapBox (Vector2 point, Vector2 size, float angle, ContactFilter2D contactFilter, Collider2D[] results);

Parámetros

pointThe center of the box.
sizeThe size of the box.
angleThe angle of the box.
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.

Valor de retorno

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

Descripción

Checks if a collider falls within a box area.

The box is defined by its center coordinate in world space and by its size.

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.


Parámetros

pointThe center of the box.
sizeThe size of the box.
angleThe angle of the box.
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 list to receive results.

Valor de retorno

void Returns the number of results placed in the results list.

Descripción

Checks if a Collider falls within a box area.

The box is defined by its center coordinate in world space and by its size.

The integer return value is the number of results written into the results list. The results list will be resized if it doesn't contain enough elements to report all the results. This prevents memory from being allocated for results when the results list does not need to be resized, and improves garbage collection performance when the query is performed frequently.

The results can also be filtered by the contactFilter.

Note that filtering by normal angle is not available for overlap functions.