Joint2D¶
Inherits: Node2D < CanvasItem < Node < Object
Inherited By: DampedSpringJoint2D, GrooveJoint2D, PinJoint2D
Base node for all joint constraints in 2D physics.
Description¶
Base node for all joint constraints in 2D physics. Joints take 2 bodies and apply a custom constraint.
Properties¶
float | bias | 0.0 |
bool | disable_collision | true |
NodePath | node_a | NodePath("") |
NodePath | node_b | NodePath("") |
Property Descriptions¶
- float bias
Default | 0.0 |
Setter | set_bias(value) |
Getter | get_bias() |
When node_a and node_b move in different directions the bias
controls how fast the joint pulls them back to their original position. The lower the bias
the more the two bodies can pull on the joint.
- bool disable_collision
Default | true |
Setter | set_exclude_nodes_from_collision(value) |
Getter | get_exclude_nodes_from_collision() |
If true
, node_a and node_b can collide.
- NodePath node_a
Default | NodePath("") |
Setter | set_node_a(value) |
Getter | get_node_a() |
The first body attached to the joint. Must derive from PhysicsBody2D.
- NodePath node_b
Default | NodePath("") |
Setter | set_node_b(value) |
Getter | get_node_b() |
The second body attached to the joint. Must derive from PhysicsBody2D.