| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970 |
- .. 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 Functions
- ----------------
- +----------------------------+------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_initial_offset<class_GrooveJoint2D_get_initial_offset>` **(** **)** const |
- +----------------------------+------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_length<class_GrooveJoint2D_get_length>` **(** **)** const |
- +----------------------------+------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_initial_offset<class_GrooveJoint2D_set_initial_offset>` **(** :ref:`float<class_float>` offset **)** |
- +----------------------------+------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_length<class_GrooveJoint2D_set_length>` **(** :ref:`float<class_float>` length **)** |
- +----------------------------+------------------------------------------------------------------------------------------------------------------+
- Member Variables
- ----------------
- - :ref:`float<class_float>` **initial_offset**
- - :ref:`float<class_float>` **length**
- Description
- -----------
- Groove constraint for 2D physics. This is useful for making a body "slide" through a segment placed in another.
- Member Function Description
- ---------------------------
- .. _class_GrooveJoint2D_get_initial_offset:
- - :ref:`float<class_float>` **get_initial_offset** **(** **)** const
- Set the final offset of the groove on body A.
- .. _class_GrooveJoint2D_get_length:
- - :ref:`float<class_float>` **get_length** **(** **)** const
- Return the length of the groove.
- .. _class_GrooveJoint2D_set_initial_offset:
- - void **set_initial_offset** **(** :ref:`float<class_float>` offset **)**
- Set the initial offset of the groove on body A.
- .. _class_GrooveJoint2D_set_length:
- - void **set_length** **(** :ref:`float<class_float>` length **)**
- Set the length of the groove.
|
