Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


CastShapeProxy(ShapeProxy, Vector2, QueryFilter, WorldCastMode, Allocator)

Returns the shape(s) that intersect the specified Circle geometry as it is cast through the world. See PhysicsQuery.QueryFilter, PhysicsQuery.WorldCastMode, PhysicsQuery.WorldCastResult and Allocator.
Read time 1 minuteLast updated 7 days ago

Definition

  • Type: Method
  • Namespace: Unity.U2D.Physics
  • Assembly: UnityEngine.PhysicsCore2DModule
public NativeArray<PhysicsQuery.WorldCastResult> CastShapeProxy(PhysicsShape.ShapeProxy shapeProxy, Vector2 translation, PhysicsQuery.QueryFilter filter, PhysicsQuery.WorldCastMode castMode = WorldCastMode.Closest, Allocator allocator = Allocator.Temp)

Parameters

shapeProxy

The shape proxy to use. This must be in world-space.

translation

The translation relative to the shape proxy defining the direction the shape proxy will move through the world.

The filter to control what results are returned.

Controls how many and in what order the results are returned.

allocator

The memory allocator to use for the results. This can only be Allocator.Temp, Allocator.TempJob or Allocator.Persistent.

Returns

Type

Description

NativeArray<WorldCastResult>The query cast results. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty.