godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (705b7a0)

Browse Source
This commit is contained in:
Godot Organization
2024-05-31 13:54:35 +00:00
parent 32f1b6ea48
commit eacfba2716
835 changed files with 17350 additions and 17256 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
classes/class_joint2d.rst
View File

@@ -21,7 +21,7 @@ Abstract base class for all 2D physics joints.
Description
-----------
Abstract base class for all joints in 2D physics. 2D joints bind together two physics bodies and apply a constraint.
Abstract base class for all joints in 2D physics. 2D joints bind together two physics bodies (:ref:`node_a<class_Joint2D_property_node_a>` and :ref:`node_b<class_Joint2D_property_node_b>`) and apply a constraint.
.. rst-class:: classref-reftable-group
@@ -66,7 +66,7 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`float<class_float>` **bias** = ``0.0``
:ref:`float<class_float>` **bias** = ``0.0`` :ref:`🔗<class_Joint2D_property_bias>`
.. rst-class:: classref-property-setget
@@ -85,14 +85,14 @@ When set to ``0``, the default value from :ref:`ProjectSettings.physics/2d/solve
.. rst-class:: classref-property
:ref:`bool<class_bool>` **disable_collision** = ``true``
:ref:`bool<class_bool>` **disable_collision** = ``true`` :ref:`🔗<class_Joint2D_property_disable_collision>`
.. rst-class:: classref-property-setget
- |void| **set_exclude_nodes_from_collision**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_exclude_nodes_from_collision**\ (\ )
If ``true``, :ref:`node_a<class_Joint2D_property_node_a>` and :ref:`node_b<class_Joint2D_property_node_b>` can not collide.
If ``true``, the two bodies bound together do not collide with each other.
.. rst-class:: classref-item-separator
@@ -102,14 +102,14 @@ If ``true``, :ref:`node_a<class_Joint2D_property_node_a>` and :ref:`node_b<class
.. rst-class:: classref-property
:ref:`NodePath<class_NodePath>` **node_a** = ``NodePath("")``
:ref:`NodePath<class_NodePath>` **node_a** = ``NodePath("")`` :ref:`🔗<class_Joint2D_property_node_a>`
.. rst-class:: classref-property-setget
- |void| **set_node_a**\ (\ value\: :ref:`NodePath<class_NodePath>`\ )
- :ref:`NodePath<class_NodePath>` **get_node_a**\ (\ )
The first body attached to the joint. Must derive from :ref:`PhysicsBody2D<class_PhysicsBody2D>`.
Path to the first body (A) attached to the joint. The node must inherit :ref:`PhysicsBody2D<class_PhysicsBody2D>`.
.. rst-class:: classref-item-separator
@@ -119,14 +119,14 @@ The first body attached to the joint. Must derive from :ref:`PhysicsBody2D<class
.. rst-class:: classref-property
:ref:`NodePath<class_NodePath>` **node_b** = ``NodePath("")``
:ref:`NodePath<class_NodePath>` **node_b** = ``NodePath("")`` :ref:`🔗<class_Joint2D_property_node_b>`
.. rst-class:: classref-property-setget
- |void| **set_node_b**\ (\ value\: :ref:`NodePath<class_NodePath>`\ )
- :ref:`NodePath<class_NodePath>` **get_node_b**\ (\ )
The second body attached to the joint. Must derive from :ref:`PhysicsBody2D<class_PhysicsBody2D>`.
Path to the second body (B) attached to the joint. The node must inherit :ref:`PhysicsBody2D<class_PhysicsBody2D>`.
.. rst-class:: classref-section-separator
@@ -141,9 +141,9 @@ Method Descriptions
.. rst-class:: classref-method
:ref:`RID<class_RID>` **get_rid**\ (\ ) |const|
:ref:`RID<class_RID>` **get_rid**\ (\ ) |const| :ref:`🔗<class_Joint2D_method_get_rid>`
Returns the joint's :ref:`RID<class_RID>`.
Returns the joint's internal :ref:`RID<class_RID>` from the :ref:`PhysicsServer2D<class_PhysicsServer2D>`.
.. |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.)`