Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

Physics2D.CircleCastNonAlloc

static function CircleCastNonAlloc(origin: Vector2, radius: float, direction: Vector2, results: RaycastHit2D[], distance: float = Mathf.Infinity, layerMask: int = DefaultRaycastLayers, minDepth: float = -Mathf.Infinity, maxDepth: float = Mathf.Infinity): int;
static int CircleCastNonAlloc(Vector2 origin, float radius, Vector2 direction, RaycastHit2D[] results, float distance = Mathf.Infinity, int layerMask = DefaultRaycastLayers, float minDepth = -Mathf.Infinity, float maxDepth = Mathf.Infinity);
static def CircleCastNonAlloc(origin as Vector2, radius as float, direction as Vector2, results as RaycastHit2D[], distance as float = Mathf.Infinity, layerMask as int = DefaultRaycastLayers, minDepth as float = -Mathf.Infinity, maxDepth as float = Mathf.Infinity) as int

Parameters

originThe point in 2D space where the shape originates.
radiusThe radius of the shape.
directionVector representing the direction of the shape.
resultsArray to receive results.
distanceMaximum distance over which to cast the shape.
layerMaskFilter to detect Colliders only on certain layers.
minDepthOnly include objects with a Z coordinate (depth) greater than this value.
maxDepthOnly include objects with a Z coordinate (depth) less than this value.

Returns

int The number of results returned.

Description

Casts a circle into the scene, returning colliders that contact with it into the provided results array.

This function is similar to the CircleCastAll function except that the results are returned in the supplied array. The integer return value is the number of objects that intersect the circle (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 circle would touch the collider. It also returns the centroid where the circle would be positioned for it to contact at that point.

See Also: LayerMask class, RaycastHit2D class, CircleCast, CircleCastAll,, DefaultRaycastLayers, IgnoreRaycastLayer, raycastsHitTriggers.