Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

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

Physics2D.BoxCastAll

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 BoxCastAll(origin: Vector2, size: Vector2, angle: float, direction: Vector2, distance: float = Mathf.Infinity, layerMask: int = DefaultRaycastLayers, minDepth: float = -Mathf.Infinity, maxDepth: float = Mathf.Infinity): RaycastHit2D[];
public static RaycastHit2D[] BoxCastAll(Vector2 origin, Vector2 size, float angle, Vector2 direction, float distance = Mathf.Infinity, int layerMask = DefaultRaycastLayers, float minDepth = -Mathf.Infinity, float maxDepth = Mathf.Infinity);

Parameters

originThe point in 2D space where the box originates.
sizeThe size of the box.
angleThe angle of the box (in degrees).
directionVector representing the direction of the box.
distanceMaximum distance over which to cast the box.
layerMaskFilter to detect Colliders only on certain 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

RaycastHit2D[] The cast results returned.

Description

Casts a box against colliders in the scene, returning all colliders that contact with it.

A BoxCast is conceptually like dragging a box through the scene in a particular direction. Any object making contact with the box can be detected and reported.

This function is similar to the BoxCast function but instead of detecting just the first collider that is hit, an array of all colliders along the path of the box is returned. The colliders in the array are sorted in order of distance from the origin point. The layerMask can be used to detect objects selectively only on certain layers (this allows you to apply the detection only to enemy characters, for example).

The returned RaycastHit2D returns both the point and normal of the contact where the box would touch the collider. It also returns the centroid where the box would be positioned for it to contact at that point.

See Also: LayerMask class, RaycastHit2D class, BoxCast, BoxCastNonAlloc, DefaultRaycastLayers, IgnoreRaycastLayer, raycastsHitTriggers.