godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add classes ref generated by makerst.py

Browse Source
This commit is contained in:
Rémi Verschelde
2016-02-07 12:17:14 +01:00
parent 5c1e9caf8d
commit 6dee0d20d4
364 changed files with 41759 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

86
classes/class_joint2d.rst Normal file
View File

@@ -0,0 +1,86 @@
.. _class_Joint2D:
Joint2D
=======
Inherits: :ref:`Node2D<class_node2d>`
-------------------------------------
Category: Core
--------------
Brief Description
-----------------
Base node for all joint constraints in 2D phyisics.
Member Functions
----------------
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_node_a<class_Joint2D_set_node_a>` **(** :ref:`NodePath<class_nodepath>` node **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`get_node_a<class_Joint2D_get_node_a>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_node_b<class_Joint2D_set_node_b>` **(** :ref:`NodePath<class_nodepath>` node **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`get_node_b<class_Joint2D_get_node_b>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bias<class_Joint2D_set_bias>` **(** :ref:`float<class_float>` bias **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bias<class_Joint2D_get_bias>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_exclude_nodes_from_collision<class_Joint2D_set_exclude_nodes_from_collision>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_exclude_nodes_from_collision<class_Joint2D_get_exclude_nodes_from_collision>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
Base node for all joint constraints in 2D phyisics. Joints take 2 bodies and apply a custom constraint.
Member Function Description
---------------------------
.. _class_Joint2D_set_node_a:
- void **set_node_a** **(** :ref:`NodePath<class_nodepath>` node **)**
Set the path to the A node for the joint. Must be of type :ref:`PhysicsBody2D<class_physicsbody2d>`.
.. _class_Joint2D_get_node_a:
- :ref:`NodePath<class_nodepath>` **get_node_a** **(** **)** const
Return the path to the A node for the joint.
.. _class_Joint2D_set_node_b:
- void **set_node_b** **(** :ref:`NodePath<class_nodepath>` node **)**
Set the path to the B node for the joint. Must be of type :ref:`PhysicsBody2D<class_physicsbody2d>`.
.. _class_Joint2D_get_node_b:
- :ref:`NodePath<class_nodepath>` **get_node_b** **(** **)** const
Return the path to the B node for the joint.
.. _class_Joint2D_set_bias:
- void **set_bias** **(** :ref:`float<class_float>` bias **)**
.. _class_Joint2D_get_bias:
- :ref:`float<class_float>` **get_bias** **(** **)** const
.. _class_Joint2D_set_exclude_nodes_from_collision:
- void **set_exclude_nodes_from_collision** **(** :ref:`bool<class_bool>` enable **)**
.. _class_Joint2D_get_exclude_nodes_from_collision:
- :ref:`bool<class_bool>` **get_exclude_nodes_from_collision** **(** **)** const