.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the GrooveJoint2D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_GrooveJoint2D:

GrooveJoint2D
=============

**Inherits:** :ref:`Joint2D<class_joint2d>` **<** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------

Groove constraint for 2D physics.

Member Variables
----------------

  .. _class_GrooveJoint2D_initial_offset:

- :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``

  .. _class_GrooveJoint2D_length:

- :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``


Description
-----------

Groove constraint for 2D physics. This is useful for making a body "slide" through a segment placed in another.