SliderJoint3D — C# API

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

class SliderJoint3DReckfellSharpInherits Joint3D

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.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

SliderJoint3DConstructor

# SliderJoint3D

C#
public SliderJoint3D();

Methods2

GetParamfloat

# GetParam

C#
public float GetParam(SliderJoint3D.Param param);

Returns the value of the given parameter.

Parameters
Name	Type	Default
`param`	`SliderJoint3D.Param`	—

Returns float

SetParamvoid

# SetParam

C#
public void SetParam(SliderJoint3D.Param param, float value);

Assigns value to the given parameter.

Parameters
Name	Type	Default
`param`	`SliderJoint3D.Param`	—
`value`	`float`	—

SliderJoint3D.Param

Value	Description
`AngularLimitDamping = 15`	Constant for accessing `angular_limit/damping`. The amount of damping of the rotation when the limit is surpassed.
`AngularLimitLower = 12`	Constant for accessing `angular_limit/lower_angle`. The lower limit of rotation in the slider.
`AngularLimitRestitution = 14`	Constant for accessing `angular_limit/restitution`. The amount of restitution of the rotation when the limit is surpassed.
`AngularLimitSoftness = 13`	Constant for accessing `angular_limit/softness`. A factor applied to the all rotation once the limit is surpassed.
`AngularLimitUpper = 11`	Constant for accessing `angular_limit/upper_angle`. The upper limit of rotation in the slider.
`AngularMotionDamping = 18`	Constant for accessing `angular_motion/damping`. The amount of damping of the rotation in the limits.
`AngularMotionRestitution = 17`	Constant for accessing `angular_motion/restitution`. The amount of restitution of the rotation in the limits.
`AngularMotionSoftness = 16`	Constant for accessing `angular_motion/softness`. A factor applied to the all rotation in the limits.
`AngularOrthogonalDamping = 21`	Constant for accessing `angular_ortho/damping`. The amount of damping of the rotation across axes orthogonal to the slider.
`AngularOrthogonalRestitution = 20`	Constant for accessing `angular_ortho/restitution`. The amount of restitution of the rotation across axes orthogonal to the slider.
`AngularOrthogonalSoftness = 19`	Constant for accessing `angular_ortho/softness`. A factor applied to the all rotation across axes orthogonal to the slider.
`LinearLimitDamping = 4`	Constant for accessing `linear_limit/damping`. The amount of damping once the slider limits are surpassed.
`LinearLimitLower = 1`	Constant for accessing `linear_limit/lower_distance`. The minimum difference between the pivot points on their X axis before damping happens.
`LinearLimitRestitution = 3`	Constant for accessing `linear_limit/restitution`. The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost.
`LinearLimitSoftness = 2`	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.
`LinearLimitUpper = 0`	Constant for accessing `linear_limit/upper_distance`. The maximum difference between the pivot points on their X axis before damping happens.
`LinearMotionDamping = 7`	Constant for accessing `linear_motion/damping`. The amount of damping inside the slider limits.
`LinearMotionRestitution = 6`	Constant for accessing `linear_motion/restitution`. The amount of restitution inside the slider limits.
`LinearMotionSoftness = 5`	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.
`LinearOrthogonalDamping = 10`	Constant for accessing `linear_motion/damping`. The amount of damping when movement is across axes orthogonal to the slider.
`LinearOrthogonalRestitution = 9`	Constant for accessing `linear_motion/restitution`. The amount of restitution when movement is across axes orthogonal to the slider.
`LinearOrthogonalSoftness = 8`	Constant for accessing `linear_ortho/softness`. A factor applied to the movement across axes orthogonal to the slider.
`Max = 22`	Represents the size of the `SliderJoint3D.Param` enum.