godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (f87858a8f)

Browse Source
This commit is contained in:
Yuri Sizov
2022-12-05 20:38:58 +03:00
parent 913ff5e602
commit a7745c4cc4
843 changed files with 158186 additions and 80821 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
classes/class_groovejoint2d.rst
View File

@@ -14,50 +14,63 @@ GrooveJoint2D
Groove constraint for 2D physics.
.. rst-class:: classref-introduction-group
Description
-----------
Groove constraint for 2D physics. This is useful for making a body "slide" through a segment placed in another.
.. rst-class:: classref-reftable-group
Properties
----------
+---------------------------+--------------------------------------------------------------------+----------+
| :ref:`float<class_float>` | :ref:`initial_offset<class_GrooveJoint2D_property_initial_offset>` | ``25.0`` |
+---------------------------+--------------------------------------------------------------------+----------+
| :ref:`float<class_float>` | :ref:`length<class_GrooveJoint2D_property_length>` | ``50.0`` |
+---------------------------+--------------------------------------------------------------------+----------+
.. table::
:widths: auto
+---------------------------+--------------------------------------------------------------------+----------+
| :ref:`float<class_float>` | :ref:`initial_offset<class_GrooveJoint2D_property_initial_offset>` | ``25.0`` |
+---------------------------+--------------------------------------------------------------------+----------+
| :ref:`float<class_float>` | :ref:`length<class_GrooveJoint2D_property_length>` | ``50.0`` |
+---------------------------+--------------------------------------------------------------------+----------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_GrooveJoint2D_property_initial_offset:
- :ref:`float<class_float>` **initial_offset**
.. rst-class:: classref-property
+-----------+---------------------------+
| *Default* | ``25.0`` |
+-----------+---------------------------+
| *Setter* | set_initial_offset(value) |
+-----------+---------------------------+
| *Getter* | get_initial_offset() |
+-----------+---------------------------+
:ref:`float<class_float>` **initial_offset** = ``25.0``
.. rst-class:: classref-property-setget
- void **set_initial_offset** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_initial_offset** **(** **)**
The body B's initial anchor position defined by the joint's origin and a local offset :ref:`initial_offset<class_GrooveJoint2D_property_initial_offset>` along the joint's Y axis (along the groove).
.. rst-class:: classref-item-separator
----
.. _class_GrooveJoint2D_property_length:
- :ref:`float<class_float>` **length**
.. rst-class:: classref-property
+-----------+-------------------+
| *Default* | ``50.0`` |
+-----------+-------------------+
| *Setter* | set_length(value) |
+-----------+-------------------+
| *Getter* | get_length() |
+-----------+-------------------+
:ref:`float<class_float>` **length** = ``50.0``
.. rst-class:: classref-property-setget
- void **set_length** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_length** **(** **)**
The groove's length. The groove is from the joint's origin towards :ref:`length<class_GrooveJoint2D_property_length>` along the joint's local Y axis.