Version: 2019.1 (switch to 2018.3 or 2017.4)
LanguageEnglish
  • C#

Physics2D.BoxCastNonAlloc

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 int BoxCastNonAlloc(Vector2 origin, Vector2 size, float angle, Vector2 direction, RaycastHit2D[] results, 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).
directionA vector representing the direction of the box.
resultsArray to receive results.
distanceThe maximum 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

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

Description

Casts a box into the Scene, returning colliders that contact with it into the provided results array.

This function is similar to the BoxCastAll function except that the results are returned in the supplied array. The integer return value is the number of objects that intersect 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 performed frequently.

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, BoxCastAll,, DefaultRaycastLayers, IgnoreRaycastLayer, raycastsHitTriggers.

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