Shape Casts

A cast translates a shape between two world-space centres with a fixed orientation. It is not a rotational sweep and does not resolve movement or slide along obstacles for you. Choose the closest form for a blocking obstacle and _all for all bodies along a path.

jolt_cast_box(sx, sy, sz, ex, ey, ez, width, depth, height, options=undefined)
jolt_cast_sphere(sx, sy, sz, ex, ey, ez, radius, options=undefined)
jolt_cast_capsule(sx, sy, sz, ex, ey, ez, height, radius, options=undefined)
jolt_cast_shape(shape, sx, sy, sz, ex, ey, ez, options=undefined)
// The same argument lists apply to jolt_cast_*_all.

A successful miss has hit: false, fraction: 1 and distance: 0; distance is not the full query length on a miss. All-hit casts keep one closest hit per body, sorted by increasing fraction. A starting penetration has fraction: 0 and initial_overlap: true; it needs overlap recovery, not ordinary forward movement.

var r = jolt_cast_sphere(0, 0, 2, 10, 0, 2, 0.25);
if (r.error_code != 0) show_debug_message(r.error_message);
else if (r.hit) show_debug_message(r.shape_position);

var hits = jolt_cast_sphere_all(0, 0, 2, 10, 0, 2, 0.25);
if (jolt_has_error()) show_debug_message(jolt_get_error_message());
else show_debug_message(array_length(hits));

Verified operation contracts#

These contracts distinguish units, return values, errors and lifetime according to the current implementation. Check results: false, 0 and undefined can mean different things for different methods.