mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 19:29:06 +00:00
67 lines
2.5 KiB
ReStructuredText
67 lines
2.5 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the PinJoint.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_PinJoint:
|
|
|
|
PinJoint
|
|
========
|
|
|
|
**Inherits:** :ref:`Joint<class_joint>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Pin Joint for 3D Shapes.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_param<class_PinJoint_get_param>` **(** :ref:`int<class_int>` param **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_param<class_PinJoint_set_param>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Member Variables
|
|
----------------
|
|
|
|
- :ref:`float<class_float>` **params/bias** - The force with wich the pinned objects stay in positional relation to each other.
|
|
|
|
The higher, the stronger.
|
|
- :ref:`float<class_float>` **params/damping** - The force with wich the pinned objects stay in velocity relation to each other.
|
|
|
|
The higher, the stronger.
|
|
- :ref:`float<class_float>` **params/impulse_clamp** - If above 0, this value is the maximum value for an impulse that this Joint produces.
|
|
|
|
Numeric Constants
|
|
-----------------
|
|
|
|
- **PARAM_BIAS** = **0** --- The force with wich the pinned objects stay in positional relation to each other.
|
|
|
|
The higher, the stronger.
|
|
- **PARAM_DAMPING** = **1** --- The force with wich the pinned objects stay in velocity relation to each other.
|
|
|
|
The higher, the stronger.
|
|
- **PARAM_IMPULSE_CLAMP** = **2** --- If above 0, this value is the maximum value for an impulse that this Joint produces.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Pin Joint for 3D Rigid Bodies. It pins 2 bodies (rigid or static) together.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_PinJoint_get_param:
|
|
|
|
- :ref:`float<class_float>` **get_param** **(** :ref:`int<class_int>` param **)** const
|
|
|
|
.. _class_PinJoint_set_param:
|
|
|
|
- void **set_param** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
|
|
|
|
|