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.OverlapCircleNonAlloc

static function OverlapCircleNonAlloc(point: Vector2, radius: float, results: Collider2D[], layerMask: int = DefaultRaycastLayers, minDepth: float = -Mathf.Infinity, maxDepth: float = Mathf.Infinity): int;
static int OverlapCircleNonAlloc(Vector2 point, float radius, Collider2D[] results, int layerMask = DefaultRaycastLayers, float minDepth = -Mathf.Infinity, float maxDepth = Mathf.Infinity);
static def OverlapCircleNonAlloc(point as Vector2, radius as float, results as Collider2D[], layerMask as int = DefaultRaycastLayers, minDepth as float = -Mathf.Infinity, maxDepth as float = Mathf.Infinity) as int

Parameters

minDepthOnly include objects with a Z coordinate (depth) greater than this value.
maxDepthOnly include objects with a Z coordinate (depth) less than this value.
pointCenter of the circle.
radiusRadius of the circle.
resultsArray to receive results.
layerMaskFilter to check objects only on specific layers.

Returns

int The number of results returned.

Description

Get a list of all colliders that fall within a circular area.

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

See Also: OverlapCircle, OverlapCircleAll.

Copyright © 2014 Unity Technologies
UnityGalleryAsset StoreBuyDownload