Class DampedSpringJoint2D

A physics joint that connects two 2D physics bodies with a spring-like force.

Inheritance

Joint2D

Node2D

CanvasItem

Node

Object

DampedSpringJoint2D

Remarks

A physics joint that connects two 2D physics bodies with a spring-like force. This resembles a spring that always wants to stretch to a given length.

Properties

damping

The spring joint's damping ratio. A value between 0 and 1. When the two bodies move into different directions the system tries to align them to the spring axis again. A high damping value forces the attached bodies to align faster.

var damping : float = 1.0

Property Value

float

Remarks

• void set_damping(float value)
• float get_damping

length

The spring joint's maximum length. The two attached bodies cannot stretch it past this value.

var length : float = 50.0

Property Value

float

Remarks

• void set_length(float value)
• float get_length

rest_length

When the bodies attached to the spring joint move they stretch or squash it. The joint always tries to resize towards this length.

var rest_length : float = 0.0

Property Value

float

Remarks

• void set_rest_length(float value)
• float get_rest_length

stiffness

The higher the value, the less the bodies attached to the joint will deform it. The joint applies an opposing force to the bodies, the product of the stiffness multiplied by the size difference from its resting length.

var stiffness : float = 20.0

Property Value

float

Remarks

• void set_stiffness(float value)
• float get_stiffness