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

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

Parameters

originThe point in 2D space where the shape originates.
radiusThe radius of the shape.
directionVector representing the direction of the shape.
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

RaycastHit2D[] The cast results returned.

Description

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

A CircleCast is conceptually like dragging a circle 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 CircleCast function but instead of detecting just the first collider that is hit, an array of all colliders along the path of the circle 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 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, CircleCastNonAlloc, DefaultRaycastLayers, IgnoreRaycastLayer, raycastsHitTriggers.