World:shapecast

Edit

Moves a shape from a starting point to an endpoint and returns any colliders it touches along its path.

This is similar to a raycast, but with a Shape instead of a point.

World:shapecast(shape, x1, y1, z1, x2, y2, z2, angle, ax, ay, az, filter, callback)
World:shapecast(shape, position, destination, orientation, filter, callback)
collider, shape, x, y, z, nx, ny, nz = World:shapecast(shape, x1, y1, z1, x2, y2, z2, angle, ax, ay, az, filter)
collider, shape, x, y, z, nx, ny, nz = World:shapecast(shape, position, destination, orientation, filter)

Notes

The callback function is passed a collider, a shape, a world-space point, a world-space normal, and a fraction:

function(collider, shape, x, y, z, nx, ny, nz, fraction)
  return fraction
end

The callback can return a fraction value used to limit the range of further hits. For example:

• Returning 0.0 will abort the shapecast and ignore all other hits.
• Returning 1.0 will call the callback for all hits.
• Returning fraction will return successively closer hits.

Shapecasts will hit sensors and sleeping colliders, but will not hit disabled colliders.

See also

• World:raycast
• World:overlapShape
• World:queryBox
• World:querySphere
• World