2
0

class_sliderjoint.rst 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SliderJoint.xml.
  6. .. _class_SliderJoint:
  7. SliderJoint
  8. ===========
  9. **Inherits:** :ref:`Joint<class_Joint>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. Slider between two PhysicsBodies in 3D.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. Slides across the X axis of the pivot object. See also :ref:`Generic6DOFJoint<class_Generic6DOFJoint>`.
  15. .. rst-class:: classref-reftable-group
  16. Properties
  17. ----------
  18. .. table::
  19. :widths: auto
  20. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  21. | :ref:`float<class_float>` | :ref:`angular_limit/damping<class_SliderJoint_property_angular_limit/damping>` | ``0.0`` |
  22. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  23. | :ref:`float<class_float>` | :ref:`angular_limit/lower_angle<class_SliderJoint_property_angular_limit/lower_angle>` | ``0.0`` |
  24. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  25. | :ref:`float<class_float>` | :ref:`angular_limit/restitution<class_SliderJoint_property_angular_limit/restitution>` | ``0.7`` |
  26. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  27. | :ref:`float<class_float>` | :ref:`angular_limit/softness<class_SliderJoint_property_angular_limit/softness>` | ``1.0`` |
  28. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  29. | :ref:`float<class_float>` | :ref:`angular_limit/upper_angle<class_SliderJoint_property_angular_limit/upper_angle>` | ``0.0`` |
  30. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  31. | :ref:`float<class_float>` | :ref:`angular_motion/damping<class_SliderJoint_property_angular_motion/damping>` | ``1.0`` |
  32. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  33. | :ref:`float<class_float>` | :ref:`angular_motion/restitution<class_SliderJoint_property_angular_motion/restitution>` | ``0.7`` |
  34. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  35. | :ref:`float<class_float>` | :ref:`angular_motion/softness<class_SliderJoint_property_angular_motion/softness>` | ``1.0`` |
  36. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  37. | :ref:`float<class_float>` | :ref:`angular_ortho/damping<class_SliderJoint_property_angular_ortho/damping>` | ``1.0`` |
  38. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  39. | :ref:`float<class_float>` | :ref:`angular_ortho/restitution<class_SliderJoint_property_angular_ortho/restitution>` | ``0.7`` |
  40. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  41. | :ref:`float<class_float>` | :ref:`angular_ortho/softness<class_SliderJoint_property_angular_ortho/softness>` | ``1.0`` |
  42. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  43. | :ref:`float<class_float>` | :ref:`linear_limit/damping<class_SliderJoint_property_linear_limit/damping>` | ``1.0`` |
  44. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  45. | :ref:`float<class_float>` | :ref:`linear_limit/lower_distance<class_SliderJoint_property_linear_limit/lower_distance>` | ``-1.0`` |
  46. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  47. | :ref:`float<class_float>` | :ref:`linear_limit/restitution<class_SliderJoint_property_linear_limit/restitution>` | ``0.7`` |
  48. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  49. | :ref:`float<class_float>` | :ref:`linear_limit/softness<class_SliderJoint_property_linear_limit/softness>` | ``1.0`` |
  50. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  51. | :ref:`float<class_float>` | :ref:`linear_limit/upper_distance<class_SliderJoint_property_linear_limit/upper_distance>` | ``1.0`` |
  52. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  53. | :ref:`float<class_float>` | :ref:`linear_motion/damping<class_SliderJoint_property_linear_motion/damping>` | ``0.0`` |
  54. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  55. | :ref:`float<class_float>` | :ref:`linear_motion/restitution<class_SliderJoint_property_linear_motion/restitution>` | ``0.7`` |
  56. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  57. | :ref:`float<class_float>` | :ref:`linear_motion/softness<class_SliderJoint_property_linear_motion/softness>` | ``1.0`` |
  58. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  59. | :ref:`float<class_float>` | :ref:`linear_ortho/damping<class_SliderJoint_property_linear_ortho/damping>` | ``1.0`` |
  60. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  61. | :ref:`float<class_float>` | :ref:`linear_ortho/restitution<class_SliderJoint_property_linear_ortho/restitution>` | ``0.7`` |
  62. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  63. | :ref:`float<class_float>` | :ref:`linear_ortho/softness<class_SliderJoint_property_linear_ortho/softness>` | ``1.0`` |
  64. +---------------------------+--------------------------------------------------------------------------------------------+----------+
  65. .. rst-class:: classref-reftable-group
  66. Methods
  67. -------
  68. .. table::
  69. :widths: auto
  70. +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
  71. | :ref:`float<class_float>` | :ref:`get_param<class_SliderJoint_method_get_param>` **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const| |
  72. +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
  73. | void | :ref:`set_param<class_SliderJoint_method_set_param>` **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)** |
  74. +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
  75. .. rst-class:: classref-section-separator
  76. ----
  77. .. rst-class:: classref-descriptions-group
  78. Enumerations
  79. ------------
  80. .. _enum_SliderJoint_Param:
  81. .. rst-class:: classref-enumeration
  82. enum **Param**:
  83. .. _class_SliderJoint_constant_PARAM_LINEAR_LIMIT_UPPER:
  84. .. rst-class:: classref-enumeration-constant
  85. :ref:`Param<enum_SliderJoint_Param>` **PARAM_LINEAR_LIMIT_UPPER** = ``0``
  86. The maximum difference between the pivot points on their X axis before damping happens.
  87. .. _class_SliderJoint_constant_PARAM_LINEAR_LIMIT_LOWER:
  88. .. rst-class:: classref-enumeration-constant
  89. :ref:`Param<enum_SliderJoint_Param>` **PARAM_LINEAR_LIMIT_LOWER** = ``1``
  90. The minimum difference between the pivot points on their X axis before damping happens.
  91. .. _class_SliderJoint_constant_PARAM_LINEAR_LIMIT_SOFTNESS:
  92. .. rst-class:: classref-enumeration-constant
  93. :ref:`Param<enum_SliderJoint_Param>` **PARAM_LINEAR_LIMIT_SOFTNESS** = ``2``
  94. A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.
  95. .. _class_SliderJoint_constant_PARAM_LINEAR_LIMIT_RESTITUTION:
  96. .. rst-class:: classref-enumeration-constant
  97. :ref:`Param<enum_SliderJoint_Param>` **PARAM_LINEAR_LIMIT_RESTITUTION** = ``3``
  98. The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost.
  99. .. _class_SliderJoint_constant_PARAM_LINEAR_LIMIT_DAMPING:
  100. .. rst-class:: classref-enumeration-constant
  101. :ref:`Param<enum_SliderJoint_Param>` **PARAM_LINEAR_LIMIT_DAMPING** = ``4``
  102. The amount of damping once the slider limits are surpassed.
  103. .. _class_SliderJoint_constant_PARAM_LINEAR_MOTION_SOFTNESS:
  104. .. rst-class:: classref-enumeration-constant
  105. :ref:`Param<enum_SliderJoint_Param>` **PARAM_LINEAR_MOTION_SOFTNESS** = ``5``
  106. 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.
  107. .. _class_SliderJoint_constant_PARAM_LINEAR_MOTION_RESTITUTION:
  108. .. rst-class:: classref-enumeration-constant
  109. :ref:`Param<enum_SliderJoint_Param>` **PARAM_LINEAR_MOTION_RESTITUTION** = ``6``
  110. The amount of restitution inside the slider limits.
  111. .. _class_SliderJoint_constant_PARAM_LINEAR_MOTION_DAMPING:
  112. .. rst-class:: classref-enumeration-constant
  113. :ref:`Param<enum_SliderJoint_Param>` **PARAM_LINEAR_MOTION_DAMPING** = ``7``
  114. The amount of damping inside the slider limits.
  115. .. _class_SliderJoint_constant_PARAM_LINEAR_ORTHOGONAL_SOFTNESS:
  116. .. rst-class:: classref-enumeration-constant
  117. :ref:`Param<enum_SliderJoint_Param>` **PARAM_LINEAR_ORTHOGONAL_SOFTNESS** = ``8``
  118. A factor applied to the movement across axes orthogonal to the slider.
  119. .. _class_SliderJoint_constant_PARAM_LINEAR_ORTHOGONAL_RESTITUTION:
  120. .. rst-class:: classref-enumeration-constant
  121. :ref:`Param<enum_SliderJoint_Param>` **PARAM_LINEAR_ORTHOGONAL_RESTITUTION** = ``9``
  122. The amount of restitution when movement is across axes orthogonal to the slider.
  123. .. _class_SliderJoint_constant_PARAM_LINEAR_ORTHOGONAL_DAMPING:
  124. .. rst-class:: classref-enumeration-constant
  125. :ref:`Param<enum_SliderJoint_Param>` **PARAM_LINEAR_ORTHOGONAL_DAMPING** = ``10``
  126. The amount of damping when movement is across axes orthogonal to the slider.
  127. .. _class_SliderJoint_constant_PARAM_ANGULAR_LIMIT_UPPER:
  128. .. rst-class:: classref-enumeration-constant
  129. :ref:`Param<enum_SliderJoint_Param>` **PARAM_ANGULAR_LIMIT_UPPER** = ``11``
  130. The upper limit of rotation in the slider.
  131. .. _class_SliderJoint_constant_PARAM_ANGULAR_LIMIT_LOWER:
  132. .. rst-class:: classref-enumeration-constant
  133. :ref:`Param<enum_SliderJoint_Param>` **PARAM_ANGULAR_LIMIT_LOWER** = ``12``
  134. The lower limit of rotation in the slider.
  135. .. _class_SliderJoint_constant_PARAM_ANGULAR_LIMIT_SOFTNESS:
  136. .. rst-class:: classref-enumeration-constant
  137. :ref:`Param<enum_SliderJoint_Param>` **PARAM_ANGULAR_LIMIT_SOFTNESS** = ``13``
  138. A factor applied to the all rotation once the limit is surpassed.
  139. .. _class_SliderJoint_constant_PARAM_ANGULAR_LIMIT_RESTITUTION:
  140. .. rst-class:: classref-enumeration-constant
  141. :ref:`Param<enum_SliderJoint_Param>` **PARAM_ANGULAR_LIMIT_RESTITUTION** = ``14``
  142. The amount of restitution of the rotation when the limit is surpassed.
  143. .. _class_SliderJoint_constant_PARAM_ANGULAR_LIMIT_DAMPING:
  144. .. rst-class:: classref-enumeration-constant
  145. :ref:`Param<enum_SliderJoint_Param>` **PARAM_ANGULAR_LIMIT_DAMPING** = ``15``
  146. The amount of damping of the rotation when the limit is surpassed.
  147. .. _class_SliderJoint_constant_PARAM_ANGULAR_MOTION_SOFTNESS:
  148. .. rst-class:: classref-enumeration-constant
  149. :ref:`Param<enum_SliderJoint_Param>` **PARAM_ANGULAR_MOTION_SOFTNESS** = ``16``
  150. A factor applied to the all rotation in the limits.
  151. .. _class_SliderJoint_constant_PARAM_ANGULAR_MOTION_RESTITUTION:
  152. .. rst-class:: classref-enumeration-constant
  153. :ref:`Param<enum_SliderJoint_Param>` **PARAM_ANGULAR_MOTION_RESTITUTION** = ``17``
  154. The amount of restitution of the rotation in the limits.
  155. .. _class_SliderJoint_constant_PARAM_ANGULAR_MOTION_DAMPING:
  156. .. rst-class:: classref-enumeration-constant
  157. :ref:`Param<enum_SliderJoint_Param>` **PARAM_ANGULAR_MOTION_DAMPING** = ``18``
  158. The amount of damping of the rotation in the limits.
  159. .. _class_SliderJoint_constant_PARAM_ANGULAR_ORTHOGONAL_SOFTNESS:
  160. .. rst-class:: classref-enumeration-constant
  161. :ref:`Param<enum_SliderJoint_Param>` **PARAM_ANGULAR_ORTHOGONAL_SOFTNESS** = ``19``
  162. A factor applied to the all rotation across axes orthogonal to the slider.
  163. .. _class_SliderJoint_constant_PARAM_ANGULAR_ORTHOGONAL_RESTITUTION:
  164. .. rst-class:: classref-enumeration-constant
  165. :ref:`Param<enum_SliderJoint_Param>` **PARAM_ANGULAR_ORTHOGONAL_RESTITUTION** = ``20``
  166. The amount of restitution of the rotation across axes orthogonal to the slider.
  167. .. _class_SliderJoint_constant_PARAM_ANGULAR_ORTHOGONAL_DAMPING:
  168. .. rst-class:: classref-enumeration-constant
  169. :ref:`Param<enum_SliderJoint_Param>` **PARAM_ANGULAR_ORTHOGONAL_DAMPING** = ``21``
  170. The amount of damping of the rotation across axes orthogonal to the slider.
  171. .. _class_SliderJoint_constant_PARAM_MAX:
  172. .. rst-class:: classref-enumeration-constant
  173. :ref:`Param<enum_SliderJoint_Param>` **PARAM_MAX** = ``22``
  174. Represents the size of the :ref:`Param<enum_SliderJoint_Param>` enum.
  175. .. rst-class:: classref-section-separator
  176. ----
  177. .. rst-class:: classref-descriptions-group
  178. Property Descriptions
  179. ---------------------
  180. .. _class_SliderJoint_property_angular_limit/damping:
  181. .. rst-class:: classref-property
  182. :ref:`float<class_float>` **angular_limit/damping** = ``0.0``
  183. .. rst-class:: classref-property-setget
  184. - void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  185. - :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  186. The amount of damping of the rotation when the limit is surpassed.
  187. A lower damping value allows a rotation initiated by body A to travel to body B slower.
  188. .. rst-class:: classref-item-separator
  189. ----
  190. .. _class_SliderJoint_property_angular_limit/lower_angle:
  191. .. rst-class:: classref-property
  192. :ref:`float<class_float>` **angular_limit/lower_angle** = ``0.0``
  193. The lower limit of rotation in the slider.
  194. .. rst-class:: classref-item-separator
  195. ----
  196. .. _class_SliderJoint_property_angular_limit/restitution:
  197. .. rst-class:: classref-property
  198. :ref:`float<class_float>` **angular_limit/restitution** = ``0.7``
  199. .. rst-class:: classref-property-setget
  200. - void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  201. - :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  202. The amount of restitution of the rotation when the limit is surpassed.
  203. Does not affect damping.
  204. .. rst-class:: classref-item-separator
  205. ----
  206. .. _class_SliderJoint_property_angular_limit/softness:
  207. .. rst-class:: classref-property
  208. :ref:`float<class_float>` **angular_limit/softness** = ``1.0``
  209. .. rst-class:: classref-property-setget
  210. - void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  211. - :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  212. A factor applied to the all rotation once the limit is surpassed.
  213. Makes all rotation slower when between 0 and 1.
  214. .. rst-class:: classref-item-separator
  215. ----
  216. .. _class_SliderJoint_property_angular_limit/upper_angle:
  217. .. rst-class:: classref-property
  218. :ref:`float<class_float>` **angular_limit/upper_angle** = ``0.0``
  219. The upper limit of rotation in the slider.
  220. .. rst-class:: classref-item-separator
  221. ----
  222. .. _class_SliderJoint_property_angular_motion/damping:
  223. .. rst-class:: classref-property
  224. :ref:`float<class_float>` **angular_motion/damping** = ``1.0``
  225. .. rst-class:: classref-property-setget
  226. - void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  227. - :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  228. The amount of damping of the rotation in the limits.
  229. .. rst-class:: classref-item-separator
  230. ----
  231. .. _class_SliderJoint_property_angular_motion/restitution:
  232. .. rst-class:: classref-property
  233. :ref:`float<class_float>` **angular_motion/restitution** = ``0.7``
  234. .. rst-class:: classref-property-setget
  235. - void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  236. - :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  237. The amount of restitution of the rotation in the limits.
  238. .. rst-class:: classref-item-separator
  239. ----
  240. .. _class_SliderJoint_property_angular_motion/softness:
  241. .. rst-class:: classref-property
  242. :ref:`float<class_float>` **angular_motion/softness** = ``1.0``
  243. .. rst-class:: classref-property-setget
  244. - void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  245. - :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  246. A factor applied to the all rotation in the limits.
  247. .. rst-class:: classref-item-separator
  248. ----
  249. .. _class_SliderJoint_property_angular_ortho/damping:
  250. .. rst-class:: classref-property
  251. :ref:`float<class_float>` **angular_ortho/damping** = ``1.0``
  252. .. rst-class:: classref-property-setget
  253. - void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  254. - :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  255. The amount of damping of the rotation across axes orthogonal to the slider.
  256. .. rst-class:: classref-item-separator
  257. ----
  258. .. _class_SliderJoint_property_angular_ortho/restitution:
  259. .. rst-class:: classref-property
  260. :ref:`float<class_float>` **angular_ortho/restitution** = ``0.7``
  261. .. rst-class:: classref-property-setget
  262. - void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  263. - :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  264. The amount of restitution of the rotation across axes orthogonal to the slider.
  265. .. rst-class:: classref-item-separator
  266. ----
  267. .. _class_SliderJoint_property_angular_ortho/softness:
  268. .. rst-class:: classref-property
  269. :ref:`float<class_float>` **angular_ortho/softness** = ``1.0``
  270. .. rst-class:: classref-property-setget
  271. - void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  272. - :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  273. A factor applied to the all rotation across axes orthogonal to the slider.
  274. .. rst-class:: classref-item-separator
  275. ----
  276. .. _class_SliderJoint_property_linear_limit/damping:
  277. .. rst-class:: classref-property
  278. :ref:`float<class_float>` **linear_limit/damping** = ``1.0``
  279. .. rst-class:: classref-property-setget
  280. - void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  281. - :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  282. The amount of damping that happens once the limit defined by :ref:`linear_limit/lower_distance<class_SliderJoint_property_linear_limit/lower_distance>` and :ref:`linear_limit/upper_distance<class_SliderJoint_property_linear_limit/upper_distance>` is surpassed.
  283. .. rst-class:: classref-item-separator
  284. ----
  285. .. _class_SliderJoint_property_linear_limit/lower_distance:
  286. .. rst-class:: classref-property
  287. :ref:`float<class_float>` **linear_limit/lower_distance** = ``-1.0``
  288. .. rst-class:: classref-property-setget
  289. - void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  290. - :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  291. The minimum difference between the pivot points on their X axis before damping happens.
  292. .. rst-class:: classref-item-separator
  293. ----
  294. .. _class_SliderJoint_property_linear_limit/restitution:
  295. .. rst-class:: classref-property
  296. :ref:`float<class_float>` **linear_limit/restitution** = ``0.7``
  297. .. rst-class:: classref-property-setget
  298. - void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  299. - :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  300. The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost.
  301. .. rst-class:: classref-item-separator
  302. ----
  303. .. _class_SliderJoint_property_linear_limit/softness:
  304. .. rst-class:: classref-property
  305. :ref:`float<class_float>` **linear_limit/softness** = ``1.0``
  306. .. rst-class:: classref-property-setget
  307. - void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  308. - :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  309. A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.
  310. .. rst-class:: classref-item-separator
  311. ----
  312. .. _class_SliderJoint_property_linear_limit/upper_distance:
  313. .. rst-class:: classref-property
  314. :ref:`float<class_float>` **linear_limit/upper_distance** = ``1.0``
  315. .. rst-class:: classref-property-setget
  316. - void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  317. - :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  318. The maximum difference between the pivot points on their X axis before damping happens.
  319. .. rst-class:: classref-item-separator
  320. ----
  321. .. _class_SliderJoint_property_linear_motion/damping:
  322. .. rst-class:: classref-property
  323. :ref:`float<class_float>` **linear_motion/damping** = ``0.0``
  324. .. rst-class:: classref-property-setget
  325. - void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  326. - :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  327. The amount of damping inside the slider limits.
  328. .. rst-class:: classref-item-separator
  329. ----
  330. .. _class_SliderJoint_property_linear_motion/restitution:
  331. .. rst-class:: classref-property
  332. :ref:`float<class_float>` **linear_motion/restitution** = ``0.7``
  333. .. rst-class:: classref-property-setget
  334. - void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  335. - :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  336. The amount of restitution inside the slider limits.
  337. .. rst-class:: classref-item-separator
  338. ----
  339. .. _class_SliderJoint_property_linear_motion/softness:
  340. .. rst-class:: classref-property
  341. :ref:`float<class_float>` **linear_motion/softness** = ``1.0``
  342. .. rst-class:: classref-property-setget
  343. - void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  344. - :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  345. 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.
  346. .. rst-class:: classref-item-separator
  347. ----
  348. .. _class_SliderJoint_property_linear_ortho/damping:
  349. .. rst-class:: classref-property
  350. :ref:`float<class_float>` **linear_ortho/damping** = ``1.0``
  351. .. rst-class:: classref-property-setget
  352. - void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  353. - :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  354. The amount of damping when movement is across axes orthogonal to the slider.
  355. .. rst-class:: classref-item-separator
  356. ----
  357. .. _class_SliderJoint_property_linear_ortho/restitution:
  358. .. rst-class:: classref-property
  359. :ref:`float<class_float>` **linear_ortho/restitution** = ``0.7``
  360. .. rst-class:: classref-property-setget
  361. - void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  362. - :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  363. The amount of restitution when movement is across axes orthogonal to the slider.
  364. .. rst-class:: classref-item-separator
  365. ----
  366. .. _class_SliderJoint_property_linear_ortho/softness:
  367. .. rst-class:: classref-property
  368. :ref:`float<class_float>` **linear_ortho/softness** = ``1.0``
  369. .. rst-class:: classref-property-setget
  370. - void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  371. - :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  372. A factor applied to the movement across axes orthogonal to the slider.
  373. .. rst-class:: classref-section-separator
  374. ----
  375. .. rst-class:: classref-descriptions-group
  376. Method Descriptions
  377. -------------------
  378. .. _class_SliderJoint_method_get_param:
  379. .. rst-class:: classref-method
  380. :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** |const|
  381. .. container:: contribute
  382. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  383. .. rst-class:: classref-item-separator
  384. ----
  385. .. _class_SliderJoint_method_set_param:
  386. .. rst-class:: classref-method
  387. void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**
  388. .. container:: contribute
  389. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  390. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  391. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  392. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  393. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`