Work in progress

Godot documentation is being updated to reflect the latest changes in version 4.0. Some documentation pages may still state outdated information. This banner will tell you if you're reading one of such pages.

The contents of this page are up to date. If you can still find outdated information, please open an issue.

PinJoint3D

Inherits: Joint3D < Node3D < Node < Object

Pin joint for 3D PhysicsBodies.

Description

Pin joint for 3D rigid bodies. It pins 2 bodies (dynamic or static) together. See also Generic6DOFJoint3D.

Properties

float

params/bias

0.3

float

params/damping

1.0

float

params/impulse_clamp

0.0

Methods

float

get_param ( Param param ) const

void

set_param ( Param param, float value )

Enumerations

enum Param:

Param PARAM_BIAS = 0

The force with which the pinned objects stay in positional relation to each other. The higher, the stronger.

Param PARAM_DAMPING = 1

The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger.

Param PARAM_IMPULSE_CLAMP = 2

If above 0, this value is the maximum value for an impulse that this Joint3D produces.

Property Descriptions

float params/bias = 0.3

The force with which the pinned objects stay in positional relation to each other. The higher, the stronger.

float params/damping = 1.0

The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger.

float params/impulse_clamp = 0.0

If above 0, this value is the maximum value for an impulse that this Joint3D produces.

Method Descriptions

float get_param ( Param param ) const

Returns the value of the specified parameter.

void set_param ( Param param, float value )

Sets the value of the specified parameter.