Version: 2017.3

Physics2D.OverlapCapsule

Cambiar al Manual
public static Collider2D OverlapCapsule (Vector2 point, Vector2 size, CapsuleDirection2D direction, float angle, int layerMask= DefaultRaycastLayers, float minDepth= -Mathf.Infinity, float maxDepth= Mathf.Infinity);

Parámetros

point Center of the capsule.
size Size of the capsule.
direction La dirección de la cápsula.
angle Angle of the capsule.
layerMask Filtro para revisar objetos solamente en capas especificas.
minDepth Solamente incluye objetos con una coordenada Z (profundidad) mayor que este valor.
maxDepth Solamente incluye objetos con una coordenada Z (profundidad) menor que este valor.

Valor de retorno

Collider2D The collider overlapping the capsule.

Descripción

Checks if a collider falls within a capsule area.

The capsule is defined by its center coordinate in world space, its size, direction and angle. 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 capsule 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: OverlapCapsule, OverlapCapsuleAll, OverlapCapsuleNonAlloc.


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

Parámetros

point Center of the capsule.
size Size of the capsule.
direction La dirección de la cápsula.
angle Angle of the capsule.
contactFilter The 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.
results The 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 capsule area.

The capsule is defined by its center coordinate in world space, its size, direction and angle.

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.