Joint2D

Inherits: Node2D < CanvasItem < Node < Object

Inherited By: DampedSpringJoint2D, GrooveJoint2D, PinJoint2D

Abstract base class for all 2D physics joints.

Description

Abstract base class for all joints in 2D physics. 2D joints bind together two physics bodies and apply a constraint.

Properties

float

bias

0.0

bool

disable_collision

true

NodePath

node_a

NodePath("")

NodePath

node_b

NodePath("")

Property Descriptions

float bias = 0.0

  • void set_bias ( float value )

  • float 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.

When set to 0, the default value from ProjectSettings.physics/2d/solver/default_constraint_bias is used.

bool disable_collision = true

  • void set_exclude_nodes_from_collision ( bool value )

  • bool get_exclude_nodes_from_collision ( )

If true, node_a and node_b can not collide.

NodePath node_a = NodePath("")

The first body attached to the joint. Must derive from PhysicsBody2D.

NodePath node_b = NodePath("")

The second body attached to the joint. Must derive from PhysicsBody2D.