Documentation
    Preparing search index...

    Interface RopeJointDescriptor

    A rope: the anchors may come no further apart than RopeJointDescriptor.maxLength (§28 "rope"). Both dimensions.

    Slack below that distance is unconstrained — a rope pulls and never pushes, which is exactly what distinguishes it from the staged distance joint.

    interface RopeJointDescriptor {
        anchorA?: Vector3Input;
        anchorB?: Vector3Input;
        bodyA: PhysicsBodyHandle;
        bodyB: PhysicsBodyHandle;
        breakForce?: number;
        breakTorque?: number;
        collisionEnabled?: boolean;
        maxLength: number;
        type: "rope";
    }

    Hierarchy (View Summary)

    Index
    anchorA?: Vector3Input

    Attachment point in bodyA's local frame. Defaults to its origin.

    anchorB?: Vector3Input

    Attachment point in bodyB's local frame. Defaults to its origin.

    First constrained body. Must differ from JointDescriptorBase.bodyB.

    Second constrained body.

    breakForce?: number

    Reaction force, in newtons, above which the joint breaks (§28 "break force"). Omitted means the joint never breaks under load.

    Enforced by PhysicsWorld, not by the solver (plan P6-2): the world reads the joint's reaction impulse after every fixed step, divides by the step delta, and destroys the joint when the magnitude exceeds this value — strictly, so a joint sitting exactly at its threshold survives. Requires an adapter that reports reactions (SolverJointAccess.reportsJointReactions); addJoint refuses a breakable joint on an adapter that does not, rather than accepting a threshold it can never enforce.

    breakTorque?: number

    Reaction torque, in newton-metres, above which the joint breaks (§28 "break torque"). See JointDescriptorBase.breakForce; either threshold alone is enough to break the joint.

    collisionEnabled?: boolean

    Whether the two jointed bodies still collide with each other (§28 "collision enable/disable"). Defaults to false, the usual choice for bodies that overlap by construction.

    maxLength: number

    Greatest distance between the anchors, in metres. Must be > 0.

    type: "rope"