Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

SliderJoint3D

Inherits: Joint3D < Node3D < Node < Object

A physics joint that restricts the movement of a 3D physics body along an axis relative to another physics body.

Description

A physics joint that restricts the movement of a 3D physics body along an axis relative to another physics body. For example, Body A could be a StaticBody3D representing a piston base, while Body B could be a RigidBody3D representing the piston head, moving up and down.

Properties

float

angular_limit/damping

0.0

float

angular_limit/lower_angle

0.0

float

angular_limit/restitution

0.7

float

angular_limit/softness

1.0

float

angular_limit/upper_angle

0.0

float

angular_motion/damping

1.0

float

angular_motion/restitution

0.7

float

angular_motion/softness

1.0

float

angular_ortho/damping

1.0

float

angular_ortho/restitution

0.7

float

angular_ortho/softness

1.0

float

linear_limit/damping

1.0

float

linear_limit/lower_distance

-1.0

float

linear_limit/restitution

0.7

float

linear_limit/softness

1.0

float

linear_limit/upper_distance

1.0

float

linear_motion/damping

0.0

float

linear_motion/restitution

0.7

float

linear_motion/softness

1.0

float

linear_ortho/damping

1.0

float

linear_ortho/restitution

0.7

float

linear_ortho/softness

1.0

Methods

float

get_param(param: Param) const

void

set_param(param: Param, value: float)


Enumerations

enum Param:

Param PARAM_LINEAR_LIMIT_UPPER = 0

The maximum difference between the pivot points on their X axis before damping happens.

Param PARAM_LINEAR_LIMIT_LOWER = 1

The minimum difference between the pivot points on their X axis before damping happens.

Param PARAM_LINEAR_LIMIT_SOFTNESS = 2

A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.

Param PARAM_LINEAR_LIMIT_RESTITUTION = 3

The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost.

Param PARAM_LINEAR_LIMIT_DAMPING = 4

The amount of damping once the slider limits are surpassed.

Param PARAM_LINEAR_MOTION_SOFTNESS = 5

A factor applied to the movement across the slider axis as long as the slider is in the limits. The lower, the slower the movement.

Param PARAM_LINEAR_MOTION_RESTITUTION = 6

The amount of restitution inside the slider limits.