DistanceJoint

API reference for DistanceJoint. Access via the 'physics' submodule.

Experimental API:

The physics submodule is a VERY experimental and new API that is highly susceptible to breaking changes in the future.

Inherits from Joint.

Properties


NameDescriptionType
current_lengthThe current length between the anchors.float
lengthThe rest length of the joint.float
limit_enabledWhether the length limits are enabled.bool
max_lengthThe maximum length limit.float
max_motor_forceThe maximum motor force.float
min_lengthThe minimum length limit.float
motor_enabledWhether the motor is enabled.bool
motor_forceThe current motor force.float
motor_speedThe target motor speed.float
spring_damping_ratioThe spring damping ratio.float
spring_enabledWhether the spring is enabled.bool
spring_hzThe spring frequency in Hertz.float

Methods


Set Length Range

set_length_range(
    min_length: SupportsFloat,
    max_length: SupportsFloat
) None

Set the minimum and maximum length limits.

Args

  • min_length : The minimum length.
  • max_length : The maximum length.