Joint2D

Realot Studio Joint2D component reference: fields, script API, behavior and examples.

#What it does

Connect physics bodies with Fixed, Revolute, Prismatic, Rope or Spring constraints.

#How to add and use Joint2D

Editor path: Select the target entity in the Hierarchy (left side) → look at the Inspector (right side) → click Add Component at the bottom of the Inspector → search for Joint2D → click the component row. The Add Component picker is a centered modal with a search box; it only lists components not already attached.

For components with a dedicated editor tool, the tool is opened or activated from the location described below. Do not assume that adding the component alone activates its editor; some systems require a separate window, panel, or viewport tool.

#Component setup & editor tools

• Select entity → Inspector → Add Component → Joint 2D. Configure the joint from its Inspector section and make sure the connected physics bodies satisfy the joint’s requirements.

#What you should see after adding it

The component appears as its own section in the Inspector. Its serialized settings are listed in the Component data table below. If a field is conditional, it appears only when the relevant mode/type is selected. If a field is a runtime state field (for example grounded or resolved velocity), treat it as read-only diagnostic state unless the API reference explicitly documents it as writable.

#How to read the settings

For every setting below, the documentation distinguishes type, default, meaning, and tuning direction where behavior is known. When a value represents a direction, use the engine's coordinate convention documented in Coordinate system; do not substitute Unity/Godot conventions.

#Component data

#Tuning behavior

These are the practical direction-of-change rules for the most important controls on this component.

#Breakable joints and drag

• breakable / breakForce (Revolute only): when the joint load exceeds breakForce the joint snaps apart. Script joint.breakable and joint.breakForce.
• jointDrag and restStiffness (Revolute only): drag/damping and the springiness that pulls the joint back to its rest pose.
• disableConnectedCollision: stop the two connected bodies from colliding with each other. It replaces the old collideConnected field, which is kept only for loading older projects.

#Script API

#Examples

this.joint.connectedEntity = findFirst("Target");

this.joint.jointType = "Spring";