Inheritance #

SliderJoint3D
Table of contents

SliderJoint3D #

is_instantiable, Node3D, Node, core, not_builtin_classes

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

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.

Members #

var angular_limit/damping: float = 0.0#

The amount of damping of the rotation when the limit is surpassed.

A lower damping value allows a rotation initiated by body A to travel to body B slower.

var angular_limit/lower_angle: float = 0.0#

The lower limit of rotation in the slider.

var angular_limit/restitution: float = 0.7#

The amount of restitution of the rotation when the limit is surpassed.

Does not affect damping.

var angular_limit/softness: float = 1.0#

A factor applied to the all rotation once the limit is surpassed.

Makes all rotation slower when between 0 and 1.

var angular_limit/upper_angle: float = 0.0#

The upper limit of rotation in the slider.

var angular_motion/damping: float = 1.0#

The amount of damping of the rotation in the limits.

var angular_motion/restitution: float = 0.7#

The amount of restitution of the rotation in the limits.

var angular_motion/softness: float = 1.0#

A factor applied to the all rotation in the limits.

var angular_ortho/damping: float = 1.0#

The amount of damping of the rotation across axes orthogonal to the slider.

var angular_ortho/restitution: float = 0.7#

The amount of restitution of the rotation across axes orthogonal to the slider.

var angular_ortho/softness: float = 1.0#

A factor applied to the all rotation across axes orthogonal to the slider.

var linear_limit/damping: float = 1.0#

The amount of damping that happens once the limit defined by linear_limit/lower_distance and linear_limit/upper_distance is surpassed.

var linear_limit/lower_distance: float = -1.0#

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

var linear_limit/restitution: float = 0.7#

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

var linear_limit/softness: float = 1.0#

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

var linear_limit/upper_distance: float = 1.0#

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

var linear_motion/damping: float = 0.0#

The amount of damping inside the slider limits.

var linear_motion/restitution: float = 0.7#

The amount of restitution inside the slider limits.

var linear_motion/softness: float = 1.0#

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.

var linear_ortho/damping: float = 1.0#

The amount of damping when movement is across axes orthogonal to the slider.

var linear_ortho/restitution: float = 0.7#

The amount of restitution when movement is across axes orthogonal to the slider.

var linear_ortho/softness: float = 1.0#

A factor applied to the movement across axes orthogonal to the slider.

Methods #

const func get_param(param: int enumSliderJoint3D.Param) -> float#

Returns the value of the given parameter (see Param constants).

func set_param(value: float) -> void#

Assigns value to the given parameter (see Param constants).

Annotations #

Constants #

const PARAM_LINEAR_LIMIT_UPPER = 0 enum Param#

Constant for accessing linear_limit/upper_distance. The maximum difference between the pivot points on their X axis before damping happens.

const PARAM_LINEAR_LIMIT_LOWER = 1 enum Param#

Constant for accessing linear_limit/lower_distance. The minimum difference between the pivot points on their X axis before damping happens.

const PARAM_LINEAR_LIMIT_SOFTNESS = 2 enum Param#

Constant for accessing linear_limit/softness. A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.

const PARAM_LINEAR_LIMIT_RESTITUTION = 3 enum Param#

Constant for accessing linear_limit/restitution. The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost.

const PARAM_LINEAR_LIMIT_DAMPING = 4 enum Param#

Constant for accessing linear_limit/damping. The amount of damping once the slider limits are surpassed.

const PARAM_LINEAR_MOTION_SOFTNESS = 5 enum Param#

Constant for accessing linear_motion/softness. 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.

const PARAM_LINEAR_MOTION_RESTITUTION = 6 enum Param#

Constant for accessing linear_motion/restitution. The amount of restitution inside the slider limits.

const PARAM_LINEAR_MOTION_DAMPING = 7 enum Param#

Constant for accessing linear_motion/damping. The amount of damping inside the slider limits.

const PARAM_LINEAR_ORTHOGONAL_SOFTNESS = 8 enum Param#

Constant for accessing linear_ortho/softness. A factor applied to the movement across axes orthogonal to the slider.

const PARAM_LINEAR_ORTHOGONAL_RESTITUTION = 9 enum Param#

Constant for accessing linear_motion/restitution. The amount of restitution when movement is across axes orthogonal to the slider.

const PARAM_LINEAR_ORTHOGONAL_DAMPING = 10 enum Param#

Constant for accessing linear_motion/damping. The amount of damping when movement is across axes orthogonal to the slider.

const PARAM_ANGULAR_LIMIT_UPPER = 11 enum Param#

Constant for accessing angular_limit/upper_angle. The upper limit of rotation in the slider.

const PARAM_ANGULAR_LIMIT_LOWER = 12 enum Param#

Constant for accessing angular_limit/lower_angle. The lower limit of rotation in the slider.

const PARAM_ANGULAR_LIMIT_SOFTNESS = 13 enum Param#

Constant for accessing angular_limit/softness. A factor applied to the all rotation once the limit is surpassed.

const PARAM_ANGULAR_LIMIT_RESTITUTION = 14 enum Param#

Constant for accessing angular_limit/restitution. The amount of restitution of the rotation when the limit is surpassed.

const PARAM_ANGULAR_LIMIT_DAMPING = 15 enum Param#

Constant for accessing angular_limit/damping. The amount of damping of the rotation when the limit is surpassed.

const PARAM_ANGULAR_MOTION_SOFTNESS = 16 enum Param#

Constant for accessing angular_motion/softness. A factor applied to the all rotation in the limits.

const PARAM_ANGULAR_MOTION_RESTITUTION = 17 enum Param#

Constant for accessing angular_motion/restitution. The amount of restitution of the rotation in the limits.

const PARAM_ANGULAR_MOTION_DAMPING = 18 enum Param#

Constant for accessing angular_motion/damping. The amount of damping of the rotation in the limits.

const PARAM_ANGULAR_ORTHOGONAL_SOFTNESS = 19 enum Param#

Constant for accessing angular_ortho/softness. A factor applied to the all rotation across axes orthogonal to the slider.

const PARAM_ANGULAR_ORTHOGONAL_RESTITUTION = 20 enum Param#

Constant for accessing angular_ortho/restitution. The amount of restitution of the rotation across axes orthogonal to the slider.

const PARAM_ANGULAR_ORTHOGONAL_DAMPING = 21 enum Param#

Constant for accessing angular_ortho/damping. The amount of damping of the rotation across axes orthogonal to the slider.

const PARAM_MAX = 22 enum Param#

Represents the size of the Param enum.

Constructors #

Enums #

Param#

enum Param { PARAM_LINEAR_LIMIT_UPPER = 0, PARAM_LINEAR_LIMIT_LOWER = 1, PARAM_LINEAR_LIMIT_SOFTNESS = 2, PARAM_LINEAR_LIMIT_RESTITUTION = 3, PARAM_LINEAR_LIMIT_DAMPING = 4, PARAM_LINEAR_MOTION_SOFTNESS = 5, PARAM_LINEAR_MOTION_RESTITUTION = 6, PARAM_LINEAR_MOTION_DAMPING = 7, PARAM_LINEAR_ORTHOGONAL_SOFTNESS = 8, PARAM_LINEAR_ORTHOGONAL_RESTITUTION = 9, PARAM_LINEAR_ORTHOGONAL_DAMPING = 10, PARAM_ANGULAR_LIMIT_UPPER = 11, PARAM_ANGULAR_LIMIT_LOWER = 12, PARAM_ANGULAR_LIMIT_SOFTNESS = 13, PARAM_ANGULAR_LIMIT_RESTITUTION = 14, PARAM_ANGULAR_LIMIT_DAMPING = 15, PARAM_ANGULAR_MOTION_SOFTNESS = 16, PARAM_ANGULAR_MOTION_RESTITUTION = 17, PARAM_ANGULAR_MOTION_DAMPING = 18, PARAM_ANGULAR_ORTHOGONAL_SOFTNESS = 19, PARAM_ANGULAR_ORTHOGONAL_RESTITUTION = 20, PARAM_ANGULAR_ORTHOGONAL_DAMPING = 21, PARAM_MAX = 22, }

Operators #

Signals #

Theme Items #

Tutorials #