Files
godot-docs-l10n/classes/es/class_conetwistjoint.rst
Rémi Verschelde cf78697eea Add localized class reference as pre-generated RST files
Currently including `zh_CN` and `es` which both have very high completion
ratios. Others will be added once they reach a significant percentage too.

These RST files will be used by godot-docs in place of its `classes` folder
after we sync with https://github.com/godotengine/godot-docs/pull/5458.

The update workflow is manual for now (example for `zh_CN`):

- Build `godotengine/godot` in the branch we currently track (now `3.x`)
- Run `godot --doctool -l zh_CN`
- Run `cd doc && make rst LANGARG=zh_CN`
- Copy `doc/_build/rst/*` to `classes/zh_CN/` here
- Make sure to have `classes/zh_CN/index.rst` copied from `docs/classes`
2021-12-21 16:07:55 +01:00

189 lines
7.2 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the ConeTwistJoint.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_ConeTwistJoint:
ConeTwistJoint
==============
**Inherits:** :ref:`Joint<class_Joint>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
A twist joint between two 3D PhysicsBodies.
Descripción
----------------------
The joint can rotate the bodies across an axis defined by the local x-axes of the :ref:`Joint<class_Joint>`.
The twist axis is initiated as the X axis of the :ref:`Joint<class_Joint>`.
Once the Bodies swing, the twist axis is calculated as the middle of the x-axes of the Joint in the local space of the two Bodies. See also :ref:`Generic6DOFJoint<class_Generic6DOFJoint>`.
Propiedades
----------------------
+---------------------------+-------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`bias<class_ConeTwistJoint_property_bias>` | ``0.3`` |
+---------------------------+-------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`relaxation<class_ConeTwistJoint_property_relaxation>` | ``1.0`` |
+---------------------------+-------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`softness<class_ConeTwistJoint_property_softness>` | ``0.8`` |
+---------------------------+-------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`swing_span<class_ConeTwistJoint_property_swing_span>` | ``45.0`` |
+---------------------------+-------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`twist_span<class_ConeTwistJoint_property_twist_span>` | ``180.0`` |
+---------------------------+-------------------------------------------------------------+-----------+
Métodos
--------------
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param<class_ConeTwistJoint_method_get_param>` **(** :ref:`Param<enum_ConeTwistJoint_Param>` param **)** |const| |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param<class_ConeTwistJoint_method_set_param>` **(** :ref:`Param<enum_ConeTwistJoint_Param>` param, :ref:`float<class_float>` value **)** |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
Enumeraciones
--------------------------
.. _enum_ConeTwistJoint_Param:
.. _class_ConeTwistJoint_constant_PARAM_SWING_SPAN:
.. _class_ConeTwistJoint_constant_PARAM_TWIST_SPAN:
.. _class_ConeTwistJoint_constant_PARAM_BIAS:
.. _class_ConeTwistJoint_constant_PARAM_SOFTNESS:
.. _class_ConeTwistJoint_constant_PARAM_RELAXATION:
.. _class_ConeTwistJoint_constant_PARAM_MAX:
enum **Param**:
- **PARAM_SWING_SPAN** = **0** --- Swing is rotation from side to side, around the axis perpendicular to the twist axis.
The swing span defines, how much rotation will not get corrected along the swing axis.
Could be defined as looseness in the ``ConeTwistJoint``.
If below 0.05, this behavior is locked.
- **PARAM_TWIST_SPAN** = **1** --- La torsión es la rotación alrededor del eje de la torsión, este valor definió cuán lejos puede torcerse la articulación.
La torsión se bloquea si está por debajo de 0,05.
- **PARAM_BIAS** = **2** --- La velocidad con la que se producirá la oscilación o la torsión.
Cuanto más alto, más rápido.
- **PARAM_SOFTNESS** = **3** --- La facilidad con la que la articulación comienza a girar. Si es demasiado baja, se necesita más fuerza para empezar a torcer la articulación.
- **PARAM_RELAXATION** = **4** --- Define cuán rápido se sincroniza la diferencia de velocidad de giro en ambos lados.
- **PARAM_MAX** = **5** --- Representa el tamaño del enum :ref:`Param<enum_ConeTwistJoint_Param>`.
Descripciones de Propiedades
--------------------------------------------------------
.. _class_ConeTwistJoint_property_bias:
- :ref:`float<class_float>` **bias**
+-----------+------------------+
| *Default* | ``0.3`` |
+-----------+------------------+
| *Setter* | set_param(value) |
+-----------+------------------+
| *Getter* | get_param() |
+-----------+------------------+
La velocidad con la que se producirá la oscilación o la torsión.
Cuanto más alto, más rápido.
----
.. _class_ConeTwistJoint_property_relaxation:
- :ref:`float<class_float>` **relaxation**
+-----------+------------------+
| *Default* | ``1.0`` |
+-----------+------------------+
| *Setter* | set_param(value) |
+-----------+------------------+
| *Getter* | get_param() |
+-----------+------------------+
Define cuán rápido se sincroniza la diferencia de velocidad de giro en ambos lados.
----
.. _class_ConeTwistJoint_property_softness:
- :ref:`float<class_float>` **softness**
+-----------+------------------+
| *Default* | ``0.8`` |
+-----------+------------------+
| *Setter* | set_param(value) |
+-----------+------------------+
| *Getter* | get_param() |
+-----------+------------------+
La facilidad con la que la articulación comienza a girar. Si es demasiado baja, se necesita más fuerza para empezar a torcer la articulación.
----
.. _class_ConeTwistJoint_property_swing_span:
- :ref:`float<class_float>` **swing_span**
+-----------+----------+
| *Default* | ``45.0`` |
+-----------+----------+
Swing is rotation from side to side, around the axis perpendicular to the twist axis.
The swing span defines, how much rotation will not get corrected along the swing axis.
Could be defined as looseness in the ``ConeTwistJoint``.
If below 0.05, this behavior is locked.
----
.. _class_ConeTwistJoint_property_twist_span:
- :ref:`float<class_float>` **twist_span**
+-----------+-----------+
| *Default* | ``180.0`` |
+-----------+-----------+
La torsión es la rotación alrededor del eje de la torsión, este valor definió cuán lejos puede torcerse la articulación.
La torsión se bloquea si está por debajo de 0,05.
Descripciones de Métodos
------------------------------------------------
.. _class_ConeTwistJoint_method_get_param:
- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_ConeTwistJoint_Param>` param **)** |const|
----
.. _class_ConeTwistJoint_method_set_param:
- void **set_param** **(** :ref:`Param<enum_ConeTwistJoint_Param>` param, :ref:`float<class_float>` value **)**
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`