Skip to content

Api > Physics > OverlapBox()


Physics.OverlapBox(PhysicBox physicBox)⚓︎

Find all colliders touching or inside of the given physic box.

Parameters:⚓︎

Name Type Description
physicBox PhysicBox The physic box. The direction field of the PhysicBox will be ignored, so can be a nil.

Returns:⚓︎

type Description
Collider[] Colliders that overlap with the given box.

Usage⚓︎

---@type PhysicBox
local physicBox;


local val0 = Physics:OverlapBox(physicBox)

Extra Detail⚓︎

Creates an invisible box you define that tests collisions by outputting any colliders that come into contact with the box.