Table of Contents

Class DampedSpringJoint2D

Namespace
Godot
Assembly
GodotSharp.dll

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.

public class DampedSpringJoint2D : Joint2D, IDisposable
Inheritance
DampedSpringJoint2D
Implements
Inherited Members

Constructors

DampedSpringJoint2D() 

public DampedSpringJoint2D()

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.

public float Damping { get; set; }

Property Value

float

Length

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

public float Length { get; set; }

Property Value

float

RestLength

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

public float RestLength { get; set; }

Property Value

float

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.

public float Stiffness { get; set; }

Property Value

float

Methods

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool
Edit this page