class_groovejoint2d.rst 1.2 KB

123456789101112131415161718192021222324252627282930313233343536
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the GrooveJoint2D.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_GrooveJoint2D:
  5. GrooveJoint2D
  6. =============
  7. **Inherits:** :ref:`Joint2D<class_joint2d>` **<** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Groove constraint for 2D physics.
  12. Member Variables
  13. ----------------
  14. .. _class_GrooveJoint2D_initial_offset:
  15. - :ref:`float<class_float>` **initial_offset** - The body B's initial anchor position defined by the joint's origin and a local offset :ref:`initial_offset<class_GrooveJoint2D_initial_offset>` along the joint's y axis (along the groove). Default value: ``25``
  16. .. _class_GrooveJoint2D_length:
  17. - :ref:`float<class_float>` **length** - The groove's length. The groove is from the joint's origin towards :ref:`length<class_GrooveJoint2D_length>` along the joint's local y axis. Default value: ``50``
  18. Description
  19. -----------
  20. Groove constraint for 2D physics. This is useful for making a body "slide" through a segment placed in another.