Legacy Documentation: Version 5.1
LanguageEnglish
  • C#
  • JS

Script language

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

Physics.CheckCapsule

Switch to Manual
public static function CheckCapsule(start: Vector3, end: Vector3, radius: float, layermask: int = DefaultRaycastLayers): bool;

Parameters

start The centre of the sphere at the start of the capsule.
end The centre of the sphere at the end of the capsule.
radius The radius of the capsule.
layerMask A Layer mask that is used to selectively ignore colliders when casting a capsule.

Description

Checks if any colliders overlap a capsule-shaped volume in world space.

The capsule is defined by the two spheres with radius around point1 and point2, which form the two ends of the capsule.

// Given the start and end waypoints of a corridor, check if there is enough
// room for an object of a certain width to pass through.
function CorridorIsWideEnough(startPt: Vector3, endPt: Vector3, width: float) {
	return Physics.CheckCapsule(startPt, endPt, width);
}