2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-07-06 16:08:05 +08:00
<class name= "SliderJoint3D" inherits= "Joint3D" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-13 04:42:36 +08:00
<brief_description >
2023-04-29 04:59:03 +08:00
A physics joint that restricts the movement of a 3D physics body along an axis relative to another physics body.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2023-04-29 04:59:03 +08:00
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.
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
</tutorials>
<methods >
2019-06-27 22:10:09 +08:00
<method name= "get_param" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "float" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "param" type= "int" enum= "SliderJoint3D.Param" />
2019-06-27 22:10:09 +08:00
<description >
</description>
</method>
<method name= "set_param" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "param" type= "int" enum= "SliderJoint3D.Param" />
<param index= "1" name= "value" type= "float" />
2019-06-27 22:10:09 +08:00
<description >
</description>
</method>
2017-09-13 04:42:36 +08:00
</methods>
<members >
2019-06-29 18:38:01 +08:00
<member name= "angular_limit/damping" type= "float" setter= "set_param" getter= "get_param" default= "0.0" >
2017-10-14 18:19:03 +08:00
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.
2017-09-13 04:42:36 +08:00
</member>
2022-08-22 17:30:48 +08:00
<member name= "angular_limit/lower_angle" type= "float" setter= "set_param" getter= "get_param" default= "0.0" >
2017-10-14 18:19:03 +08:00
The lower limit of rotation in the slider.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_limit/restitution" type= "float" setter= "set_param" getter= "get_param" default= "0.7" >
2017-10-14 18:19:03 +08:00
The amount of restitution of the rotation when the limit is surpassed.
Does not affect damping.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_limit/softness" type= "float" setter= "set_param" getter= "get_param" default= "1.0" >
2017-10-14 18:19:03 +08:00
A factor applied to the all rotation once the limit is surpassed.
Makes all rotation slower when between 0 and 1.
2017-09-13 04:42:36 +08:00
</member>
2022-08-22 17:30:48 +08:00
<member name= "angular_limit/upper_angle" type= "float" setter= "set_param" getter= "get_param" default= "0.0" >
2017-10-14 18:19:03 +08:00
The upper limit of rotation in the slider.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_motion/damping" type= "float" setter= "set_param" getter= "get_param" default= "1.0" >
2017-10-14 18:19:03 +08:00
The amount of damping of the rotation in the limits.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_motion/restitution" type= "float" setter= "set_param" getter= "get_param" default= "0.7" >
2017-10-14 18:19:03 +08:00
The amount of restitution of the rotation in the limits.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_motion/softness" type= "float" setter= "set_param" getter= "get_param" default= "1.0" >
2017-10-14 18:19:03 +08:00
A factor applied to the all rotation in the limits.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_ortho/damping" type= "float" setter= "set_param" getter= "get_param" default= "1.0" >
2017-10-14 18:19:03 +08:00
The amount of damping of the rotation across axes orthogonal to the slider.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_ortho/restitution" type= "float" setter= "set_param" getter= "get_param" default= "0.7" >
2017-10-14 18:19:03 +08:00
The amount of restitution of the rotation across axes orthogonal to the slider.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_ortho/softness" type= "float" setter= "set_param" getter= "get_param" default= "1.0" >
2017-10-14 18:19:03 +08:00
A factor applied to the all rotation across axes orthogonal to the slider.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit/damping" type= "float" setter= "set_param" getter= "get_param" default= "1.0" >
2017-10-14 18:19:03 +08:00
The amount of damping that happens once the limit defined by [member linear_limit/lower_distance] and [member linear_limit/upper_distance] is surpassed.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit/lower_distance" type= "float" setter= "set_param" getter= "get_param" default= "-1.0" >
2019-06-22 07:04:47 +08:00
The minimum difference between the pivot points on their X axis before damping happens.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit/restitution" type= "float" setter= "set_param" getter= "get_param" default= "0.7" >
2017-10-14 18:19:03 +08:00
The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit/softness" type= "float" setter= "set_param" getter= "get_param" default= "1.0" >
2018-01-19 04:37:17 +08:00
A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit/upper_distance" type= "float" setter= "set_param" getter= "get_param" default= "1.0" >
2019-06-22 07:04:47 +08:00
The maximum difference between the pivot points on their X axis before damping happens.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_motion/damping" type= "float" setter= "set_param" getter= "get_param" default= "0.0" >
2017-10-14 18:19:03 +08:00
The amount of damping inside the slider limits.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_motion/restitution" type= "float" setter= "set_param" getter= "get_param" default= "0.7" >
2017-10-14 18:19:03 +08:00
The amount of restitution inside the slider limits.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_motion/softness" type= "float" setter= "set_param" getter= "get_param" default= "1.0" >
2018-01-19 04:37:17 +08:00
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.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_ortho/damping" type= "float" setter= "set_param" getter= "get_param" default= "1.0" >
2018-01-19 04:37:17 +08:00
The amount of damping when movement is across axes orthogonal to the slider.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_ortho/restitution" type= "float" setter= "set_param" getter= "get_param" default= "0.7" >
2018-01-19 04:37:17 +08:00
The amount of restitution when movement is across axes orthogonal to the slider.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_ortho/softness" type= "float" setter= "set_param" getter= "get_param" default= "1.0" >
2018-01-19 04:37:17 +08:00
A factor applied to the movement across axes orthogonal to the slider.
2017-09-13 04:42:36 +08:00
</member>
</members>
<constants >
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_LINEAR_LIMIT_UPPER" value= "0" enum= "Param" >
2019-06-22 07:04:47 +08:00
The maximum difference between the pivot points on their X axis before damping happens.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_LINEAR_LIMIT_LOWER" value= "1" enum= "Param" >
2019-06-22 07:04:47 +08:00
The minimum difference between the pivot points on their X axis before damping happens.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_LINEAR_LIMIT_SOFTNESS" value= "2" enum= "Param" >
2018-01-19 04:37:17 +08:00
A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_LINEAR_LIMIT_RESTITUTION" value= "3" enum= "Param" >
2023-07-12 06:33:49 +08:00
The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_LINEAR_LIMIT_DAMPING" value= "4" enum= "Param" >
2017-10-14 18:19:03 +08:00
The amount of damping once the slider limits are surpassed.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_LINEAR_MOTION_SOFTNESS" value= "5" enum= "Param" >
2018-01-19 04:37:17 +08:00
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.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_LINEAR_MOTION_RESTITUTION" value= "6" enum= "Param" >
2017-10-14 18:19:03 +08:00
The amount of restitution inside the slider limits.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_LINEAR_MOTION_DAMPING" value= "7" enum= "Param" >
2017-10-14 18:19:03 +08:00
The amount of damping inside the slider limits.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_LINEAR_ORTHOGONAL_SOFTNESS" value= "8" enum= "Param" >
2018-01-19 04:37:17 +08:00
A factor applied to the movement across axes orthogonal to the slider.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_LINEAR_ORTHOGONAL_RESTITUTION" value= "9" enum= "Param" >
2018-01-19 04:37:17 +08:00
The amount of restitution when movement is across axes orthogonal to the slider.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_LINEAR_ORTHOGONAL_DAMPING" value= "10" enum= "Param" >
2018-01-19 04:37:17 +08:00
The amount of damping when movement is across axes orthogonal to the slider.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_ANGULAR_LIMIT_UPPER" value= "11" enum= "Param" >
2017-10-14 18:19:03 +08:00
The upper limit of rotation in the slider.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_ANGULAR_LIMIT_LOWER" value= "12" enum= "Param" >
2017-10-14 18:19:03 +08:00
The lower limit of rotation in the slider.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_ANGULAR_LIMIT_SOFTNESS" value= "13" enum= "Param" >
2017-10-14 18:19:03 +08:00
A factor applied to the all rotation once the limit is surpassed.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_ANGULAR_LIMIT_RESTITUTION" value= "14" enum= "Param" >
2017-10-14 18:19:03 +08:00
The amount of restitution of the rotation when the limit is surpassed.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_ANGULAR_LIMIT_DAMPING" value= "15" enum= "Param" >
2017-10-14 18:19:03 +08:00
The amount of damping of the rotation when the limit is surpassed.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_ANGULAR_MOTION_SOFTNESS" value= "16" enum= "Param" >
2017-10-14 18:19:03 +08:00
A factor applied to the all rotation in the limits.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_ANGULAR_MOTION_RESTITUTION" value= "17" enum= "Param" >
2017-10-14 18:19:03 +08:00
The amount of restitution of the rotation in the limits.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_ANGULAR_MOTION_DAMPING" value= "18" enum= "Param" >
2017-10-14 18:19:03 +08:00
The amount of damping of the rotation in the limits.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_ANGULAR_ORTHOGONAL_SOFTNESS" value= "19" enum= "Param" >
2017-10-14 18:19:03 +08:00
A factor applied to the all rotation across axes orthogonal to the slider.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_ANGULAR_ORTHOGONAL_RESTITUTION" value= "20" enum= "Param" >
2017-10-14 18:19:03 +08:00
The amount of restitution of the rotation across axes orthogonal to the slider.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_ANGULAR_ORTHOGONAL_DAMPING" value= "21" enum= "Param" >
2017-10-14 18:19:03 +08:00
The amount of damping of the rotation across axes orthogonal to the slider.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_MAX" value= "22" enum= "Param" >
2019-06-27 17:10:53 +08:00
Represents the size of the [enum Param] enum.
2017-09-13 04:42:36 +08:00
</constant>
</constants>
</class>