A simple 2D distance joint for Godot that is not a spring.
This script does not allow the creation of double/triple/etc. pendulums and that is by design. Rigidbody2Ds will behave as if linked by a string that does have some mass.
- Copy the distance_joint_2d.gd file to your project.
- Instantiate a DistanceJoint2D node in the scene where you want to use it.
- Assign nodes to the DistanceJoint2D in one of two ways:
- Assign a pivot (any Node2D) and add as many Rigidbody2D nodes to the links array as you wish.
- Assign at least two Rigidbody2D nodes to the links array, without a pivot.
| Property | Type | Description | Default Value |
|---|---|---|---|
| disable_collision | bool | Disables collision between all nodes in the system (pivot and links) | true |
| pivot | NodePath | Assigns a static pivot to the system, creating an anchor for the chain of links to hang from. If the pivot is a Rigidbody2D, it will be frozen on joint initialization. | "" |
| links | Array[Rigidbody2D] | The array that holds the Rigidbody2D nodes that need to be in the system. They will be linked to each other in the order they are added to the array. | N/A |
| auto_distance | bool | If true, the maximum distance between the links will be calculated from their position at the time of joint initialization. total_distance will be the sum of all the distances between links. This allows for the distances between links to not be uniform. If false, the distance between links will be uniform and based on the total_distance of the joint. | false |
| total_distance | float | The total allowed distance between the pivot (or first link if no pivot is set) and the last link in the system. Changing it at runtime will have no effect if auto_distance is true. | |
| joint_type | JointType (enum) | The type of the joint. If set to CHAIN, links will be linked in a chain one after the other. If set to ORBIT, they will orbit the pivot or common centerpoint (if no pivot is assigned.) | JointType.CHAIN |
| fixed_distance | bool | If TRUE, the joint will try to keep a fixed distance between the the links. | false |
- When having multiple links and a pivot assigned, the second link in the chain will jitter a lot.
- Currently, if fixed_distance is true, the joint overstretches, akin to a spring. Needs improvement.
- Mode that allows the creation of chaotic pendulums.
