godot-docs/classes/class_physicalbone.rst

:github_url: hide

.. 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
-----------------



Properties
----------

+-----------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------+
| :ref:`Transform<class_Transform>`             | :ref:`body_offset<class_PhysicalBone_property_body_offset>`     | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) |
+-----------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------+
| :ref:`float<class_float>`                     | :ref:`bounce<class_PhysicalBone_property_bounce>`               | 0.0                                             |
+-----------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------+
| :ref:`float<class_float>`                     | :ref:`friction<class_PhysicalBone_property_friction>`           | 1.0                                             |
+-----------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------+
| :ref:`float<class_float>`                     | :ref:`gravity_scale<class_PhysicalBone_property_gravity_scale>` | 1.0                                             |
+-----------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------+
| :ref:`Transform<class_Transform>`             | :ref:`joint_offset<class_PhysicalBone_property_joint_offset>`   | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) |
+-----------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------+
| :ref:`JointType<enum_PhysicalBone_JointType>` | :ref:`joint_type<class_PhysicalBone_property_joint_type>`       | 0                                               |
+-----------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------+
| :ref:`float<class_float>`                     | :ref:`mass<class_PhysicalBone_property_mass>`                   | 1.0                                             |
+-----------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------+
| :ref:`float<class_float>`                     | :ref:`weight<class_PhysicalBone_property_weight>`               | 9.8                                             |
+-----------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------+

Methods
-------

+-------------------------+-------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`   | :ref:`get_bone_id<class_PhysicalBone_method_get_bone_id>` **(** **)** const               |
+-------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_simulate_physics<class_PhysicalBone_method_get_simulate_physics>` **(** **)**   |
+-------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_simulating_physics<class_PhysicalBone_method_is_simulating_physics>` **(** **)** |
+-------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_static_body<class_PhysicalBone_method_is_static_body>` **(** **)**               |
+-------------------------+-------------------------------------------------------------------------------------------+

Enumerations
------------

.. _enum_PhysicalBone_JointType:

.. _class_PhysicalBone_constant_JOINT_TYPE_NONE:

.. _class_PhysicalBone_constant_JOINT_TYPE_PIN:

.. _class_PhysicalBone_constant_JOINT_TYPE_CONE:

.. _class_PhysicalBone_constant_JOINT_TYPE_HINGE:

.. _class_PhysicalBone_constant_JOINT_TYPE_SLIDER:

.. _class_PhysicalBone_constant_JOINT_TYPE_6DOF:

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**

Property Descriptions
---------------------

.. _class_PhysicalBone_property_body_offset:

- :ref:`Transform<class_Transform>` **body_offset**

+-----------+-------------------------------------------------+
| *Default* | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) |
+-----------+-------------------------------------------------+
| *Setter*  | set_body_offset(value)                          |
+-----------+-------------------------------------------------+
| *Getter*  | get_body_offset()                               |
+-----------+-------------------------------------------------+

.. _class_PhysicalBone_property_bounce:

- :ref:`float<class_float>` **bounce**

+-----------+-------------------+
| *Default* | 0.0               |
+-----------+-------------------+
| *Setter*  | set_bounce(value) |
+-----------+-------------------+
| *Getter*  | get_bounce()      |
+-----------+-------------------+

.. _class_PhysicalBone_property_friction:

- :ref:`float<class_float>` **friction**

+-----------+---------------------+
| *Default* | 1.0                 |
+-----------+---------------------+
| *Setter*  | set_friction(value) |
+-----------+---------------------+
| *Getter*  | get_friction()      |
+-----------+---------------------+

.. _class_PhysicalBone_property_gravity_scale:

- :ref:`float<class_float>` **gravity_scale**

+-----------+--------------------------+
| *Default* | 1.0                      |
+-----------+--------------------------+
| *Setter*  | set_gravity_scale(value) |
+-----------+--------------------------+
| *Getter*  | get_gravity_scale()      |
+-----------+--------------------------+

.. _class_PhysicalBone_property_joint_offset:

- :ref:`Transform<class_Transform>` **joint_offset**

+-----------+-------------------------------------------------+
| *Default* | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) |
+-----------+-------------------------------------------------+
| *Setter*  | set_joint_offset(value)                         |
+-----------+-------------------------------------------------+
| *Getter*  | get_joint_offset()                              |
+-----------+-------------------------------------------------+

.. _class_PhysicalBone_property_joint_type:

- :ref:`JointType<enum_PhysicalBone_JointType>` **joint_type**

+-----------+-----------------------+
| *Default* | 0                     |
+-----------+-----------------------+
| *Setter*  | set_joint_type(value) |
+-----------+-----------------------+
| *Getter*  | get_joint_type()      |
+-----------+-----------------------+

.. _class_PhysicalBone_property_mass:

- :ref:`float<class_float>` **mass**

+-----------+-----------------+
| *Default* | 1.0             |
+-----------+-----------------+
| *Setter*  | set_mass(value) |
+-----------+-----------------+
| *Getter*  | get_mass()      |
+-----------+-----------------+

.. _class_PhysicalBone_property_weight:

- :ref:`float<class_float>` **weight**

+-----------+-------------------+
| *Default* | 9.8               |
+-----------+-------------------+
| *Setter*  | set_weight(value) |
+-----------+-------------------+
| *Getter*  | get_weight()      |
+-----------+-------------------+

Method Descriptions
-------------------

.. _class_PhysicalBone_method_get_bone_id:

- :ref:`int<class_int>` **get_bone_id** **(** **)** const

.. _class_PhysicalBone_method_get_simulate_physics:

- :ref:`bool<class_bool>` **get_simulate_physics** **(** **)**

.. _class_PhysicalBone_method_is_simulating_physics:

- :ref:`bool<class_bool>` **is_simulating_physics** **(** **)**

.. _class_PhysicalBone_method_is_static_body:

- :ref:`bool<class_bool>` **is_static_body** **(** **)**