Files
godot-docs/classes/class_physicalbone.rst
T

103 lines
3.0 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the PhysicalBone.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_PhysicalBone:
PhysicalBone
============
**Inherits:** :ref:`PhysicsBody<class_physicsbody>` **<** :ref:`CollisionObject<class_collisionobject>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+--------------------------+------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_bone_id<class_PhysicalBone_get_bone_id>` **(** **)** const |
+--------------------------+------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_simulate_physics<class_PhysicalBone_get_simulate_physics>` **(** **)** |
+--------------------------+------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_simulating_physics<class_PhysicalBone_is_simulating_physics>` **(** **)** |
+--------------------------+------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_static_body<class_PhysicalBone_is_static_body>` **(** **)** |
+--------------------------+------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_PhysicalBone_body_offset:
- :ref:`Transform<class_transform>` **body_offset**
.. _class_PhysicalBone_bounce:
- :ref:`float<class_float>` **bounce**
.. _class_PhysicalBone_friction:
- :ref:`float<class_float>` **friction**
.. _class_PhysicalBone_gravity_scale:
- :ref:`float<class_float>` **gravity_scale**
.. _class_PhysicalBone_joint_offset:
- :ref:`Transform<class_transform>` **joint_offset**
.. _class_PhysicalBone_joint_type:
- :ref:`JointType<enum_physicalbone_jointtype>` **joint_type**
.. _class_PhysicalBone_mass:
- :ref:`float<class_float>` **mass**
.. _class_PhysicalBone_weight:
- :ref:`float<class_float>` **weight**
Enums
-----
.. _enum_PhysicalBone_JointType:
enum **JointType**
- **JOINT_TYPE_NONE** = **0**
- **JOINT_TYPE_PIN** = **1**
- **JOINT_TYPE_CONE** = **2**
- **JOINT_TYPE_HINGE** = **3**
- **JOINT_TYPE_SLIDER** = **4**
- **JOINT_TYPE_6DOF** = **5**
Member Function Description
---------------------------
.. _class_PhysicalBone_get_bone_id:
- :ref:`int<class_int>` **get_bone_id** **(** **)** const
.. _class_PhysicalBone_get_simulate_physics:
- :ref:`bool<class_bool>` **get_simulate_physics** **(** **)**
.. _class_PhysicalBone_is_simulating_physics:
- :ref:`bool<class_bool>` **is_simulating_physics** **(** **)**
.. _class_PhysicalBone_is_static_body:
- :ref:`bool<class_bool>` **is_static_body** **(** **)**