Carry: moving objects

Carry is the current jolt_grabber() controller. Enable eligible bodies with set_grab_enabled(true). It holds the center of mass unless set_grab_point(x,y,z) defines a body-local point; change that point after release.

Example#

body.set_grab_enabled(true);
carry = jolt_grabber();
carry.set_camera(o_control_bbmod_camera);
carry.set_distances(3, 1.5, 0.1, 3, 4);
carry.set_preserve_grab_distance(true);
carry.set_max_mass(30);
carry.set_strength(1200);
carry.set_max_torque(300);
// End Step:
carry.update_controls();

Usage and limits#

set_distances takes selection reach, hold distance, minimum, maximum and break distance in metres. Require min ≤ hold ≤ max and break > max(reach, maximum). preserve_grab_distance defaults false in the library; the demo enables it.

Default input is LMB pick/release, RMB plus mouse rotate, wheel distance, R realign and F throw. Camera Step must honor carry.controls_use_mouse(id) before mouse-look; call update_controls in End Step after the camera. Lost focus or missing/unlocked camera releases. Do not process automatic and manual input twice.

set_auto_upright, set_yaw_follow and set_snap_step act through physical torque; orientation options default off. Collision, mass and force limits remain effective. External joints normally block Carry. Internal ragdoll joints and opted-in hosts with attached controls are supported; moving handles are not Carry items. Soft Bodies use get_held_type()/get_soft_body(), while get_body() remains rigid-only. get_last_reason() explains failed acquisition. Destroy the grabber in Clean Up.

API reference#

Public function and method signatures. Call methods on the returned instance; parameters with defaults are optional.

Related guides#

• Migrating existing code›
• Mouse interaction with controls›

Penetration relationships are exempt from the usual rejection of externally constrained mechanisms. Rigid bodies, ragdolls and Soft Bodies are supported; held_type distinguishes them. Force and torque remain limited and contact can change the held orientation.

• Grip›

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.