class_physicalbone3d.rst 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583
  1. :github_url: hide
  2. .. meta::
  3. :keywords: ragdoll
  4. .. DO NOT EDIT THIS FILE!!!
  5. .. Generated automatically from Godot engine sources.
  6. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  7. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicalBone3D.xml.
  8. .. _class_PhysicalBone3D:
  9. PhysicalBone3D
  10. ==============
  11. **Inherits:** :ref:`PhysicsBody3D<class_PhysicsBody3D>` **<** :ref:`CollisionObject3D<class_CollisionObject3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  12. A physics body used to make bones in a :ref:`Skeleton3D<class_Skeleton3D>` react to physics.
  13. .. rst-class:: classref-introduction-group
  14. Description
  15. -----------
  16. The **PhysicalBone3D** node is a physics body that can be used to make bones in a :ref:`Skeleton3D<class_Skeleton3D>` react to physics.
  17. .. rst-class:: classref-reftable-group
  18. Properties
  19. ----------
  20. .. table::
  21. :widths: auto
  22. +-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+
  23. | :ref:`float<class_float>` | :ref:`angular_damp<class_PhysicalBone3D_property_angular_damp>` | ``0.0`` |
  24. +-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+
  25. | :ref:`DampMode<enum_PhysicalBone3D_DampMode>` | :ref:`angular_damp_mode<class_PhysicalBone3D_property_angular_damp_mode>` | ``0`` |
  26. +-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+
  27. | :ref:`Vector3<class_Vector3>` | :ref:`angular_velocity<class_PhysicalBone3D_property_angular_velocity>` | ``Vector3(0, 0, 0)`` |
  28. +-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+
  29. | :ref:`Transform3D<class_Transform3D>` | :ref:`body_offset<class_PhysicalBone3D_property_body_offset>` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` |
  30. +-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+
  31. | :ref:`float<class_float>` | :ref:`bounce<class_PhysicalBone3D_property_bounce>` | ``0.0`` |
  32. +-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+
  33. | :ref:`bool<class_bool>` | :ref:`can_sleep<class_PhysicalBone3D_property_can_sleep>` | ``true`` |
  34. +-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+
  35. | :ref:`bool<class_bool>` | :ref:`custom_integrator<class_PhysicalBone3D_property_custom_integrator>` | ``false`` |
  36. +-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+
  37. | :ref:`float<class_float>` | :ref:`friction<class_PhysicalBone3D_property_friction>` | ``1.0`` |
  38. +-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+
  39. | :ref:`float<class_float>` | :ref:`gravity_scale<class_PhysicalBone3D_property_gravity_scale>` | ``1.0`` |
  40. +-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+
  41. | :ref:`Transform3D<class_Transform3D>` | :ref:`joint_offset<class_PhysicalBone3D_property_joint_offset>` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` |
  42. +-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+
  43. | :ref:`Vector3<class_Vector3>` | :ref:`joint_rotation<class_PhysicalBone3D_property_joint_rotation>` | ``Vector3(0, 0, 0)`` |
  44. +-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+
  45. | :ref:`JointType<enum_PhysicalBone3D_JointType>` | :ref:`joint_type<class_PhysicalBone3D_property_joint_type>` | ``0`` |
  46. +-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+
  47. | :ref:`float<class_float>` | :ref:`linear_damp<class_PhysicalBone3D_property_linear_damp>` | ``0.0`` |
  48. +-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+
  49. | :ref:`DampMode<enum_PhysicalBone3D_DampMode>` | :ref:`linear_damp_mode<class_PhysicalBone3D_property_linear_damp_mode>` | ``0`` |
  50. +-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+
  51. | :ref:`Vector3<class_Vector3>` | :ref:`linear_velocity<class_PhysicalBone3D_property_linear_velocity>` | ``Vector3(0, 0, 0)`` |
  52. +-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+
  53. | :ref:`float<class_float>` | :ref:`mass<class_PhysicalBone3D_property_mass>` | ``1.0`` |
  54. +-------------------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+
  55. .. rst-class:: classref-reftable-group
  56. Methods
  57. -------
  58. .. table::
  59. :widths: auto
  60. +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | |void| | :ref:`_integrate_forces<class_PhysicalBone3D_private_method__integrate_forces>`\ (\ state\: :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>`\ ) |virtual| |
  62. +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | |void| | :ref:`apply_central_impulse<class_PhysicalBone3D_method_apply_central_impulse>`\ (\ impulse\: :ref:`Vector3<class_Vector3>`\ ) |
  64. +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | |void| | :ref:`apply_impulse<class_PhysicalBone3D_method_apply_impulse>`\ (\ impulse\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) |
  66. +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | :ref:`int<class_int>` | :ref:`get_bone_id<class_PhysicalBone3D_method_get_bone_id>`\ (\ ) |const| |
  68. +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | :ref:`bool<class_bool>` | :ref:`get_simulate_physics<class_PhysicalBone3D_method_get_simulate_physics>`\ (\ ) |
  70. +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | :ref:`bool<class_bool>` | :ref:`is_simulating_physics<class_PhysicalBone3D_method_is_simulating_physics>`\ (\ ) |
  72. +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. .. rst-class:: classref-section-separator
  74. ----
  75. .. rst-class:: classref-descriptions-group
  76. Enumerations
  77. ------------
  78. .. _enum_PhysicalBone3D_DampMode:
  79. .. rst-class:: classref-enumeration
  80. enum **DampMode**: :ref:`🔗<enum_PhysicalBone3D_DampMode>`
  81. .. _class_PhysicalBone3D_constant_DAMP_MODE_COMBINE:
  82. .. rst-class:: classref-enumeration-constant
  83. :ref:`DampMode<enum_PhysicalBone3D_DampMode>` **DAMP_MODE_COMBINE** = ``0``
  84. In this mode, the body's damping value is added to any value set in areas or the default value.
  85. .. _class_PhysicalBone3D_constant_DAMP_MODE_REPLACE:
  86. .. rst-class:: classref-enumeration-constant
  87. :ref:`DampMode<enum_PhysicalBone3D_DampMode>` **DAMP_MODE_REPLACE** = ``1``
  88. In this mode, the body's damping value replaces any value set in areas or the default value.
  89. .. rst-class:: classref-item-separator
  90. ----
  91. .. _enum_PhysicalBone3D_JointType:
  92. .. rst-class:: classref-enumeration
  93. enum **JointType**: :ref:`🔗<enum_PhysicalBone3D_JointType>`
  94. .. _class_PhysicalBone3D_constant_JOINT_TYPE_NONE:
  95. .. rst-class:: classref-enumeration-constant
  96. :ref:`JointType<enum_PhysicalBone3D_JointType>` **JOINT_TYPE_NONE** = ``0``
  97. .. container:: contribute
  98. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  99. .. _class_PhysicalBone3D_constant_JOINT_TYPE_PIN:
  100. .. rst-class:: classref-enumeration-constant
  101. :ref:`JointType<enum_PhysicalBone3D_JointType>` **JOINT_TYPE_PIN** = ``1``
  102. .. container:: contribute
  103. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  104. .. _class_PhysicalBone3D_constant_JOINT_TYPE_CONE:
  105. .. rst-class:: classref-enumeration-constant
  106. :ref:`JointType<enum_PhysicalBone3D_JointType>` **JOINT_TYPE_CONE** = ``2``
  107. .. container:: contribute
  108. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  109. .. _class_PhysicalBone3D_constant_JOINT_TYPE_HINGE:
  110. .. rst-class:: classref-enumeration-constant
  111. :ref:`JointType<enum_PhysicalBone3D_JointType>` **JOINT_TYPE_HINGE** = ``3``
  112. .. container:: contribute
  113. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  114. .. _class_PhysicalBone3D_constant_JOINT_TYPE_SLIDER:
  115. .. rst-class:: classref-enumeration-constant
  116. :ref:`JointType<enum_PhysicalBone3D_JointType>` **JOINT_TYPE_SLIDER** = ``4``
  117. .. container:: contribute
  118. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  119. .. _class_PhysicalBone3D_constant_JOINT_TYPE_6DOF:
  120. .. rst-class:: classref-enumeration-constant
  121. :ref:`JointType<enum_PhysicalBone3D_JointType>` **JOINT_TYPE_6DOF** = ``5``
  122. .. container:: contribute
  123. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  124. .. rst-class:: classref-section-separator
  125. ----
  126. .. rst-class:: classref-descriptions-group
  127. Property Descriptions
  128. ---------------------
  129. .. _class_PhysicalBone3D_property_angular_damp:
  130. .. rst-class:: classref-property
  131. :ref:`float<class_float>` **angular_damp** = ``0.0`` :ref:`🔗<class_PhysicalBone3D_property_angular_damp>`
  132. .. rst-class:: classref-property-setget
  133. - |void| **set_angular_damp**\ (\ value\: :ref:`float<class_float>`\ )
  134. - :ref:`float<class_float>` **get_angular_damp**\ (\ )
  135. Damps the body's rotation. By default, the body will use the **Default Angular Damp** in **Project > Project Settings > Physics > 3d** or any value override set by an :ref:`Area3D<class_Area3D>` the body is in. Depending on :ref:`angular_damp_mode<class_PhysicalBone3D_property_angular_damp_mode>`, you can set :ref:`angular_damp<class_PhysicalBone3D_property_angular_damp>` to be added to or to replace the body's damping value.
  136. See :ref:`ProjectSettings.physics/3d/default_angular_damp<class_ProjectSettings_property_physics/3d/default_angular_damp>` for more details about damping.
  137. .. rst-class:: classref-item-separator
  138. ----
  139. .. _class_PhysicalBone3D_property_angular_damp_mode:
  140. .. rst-class:: classref-property
  141. :ref:`DampMode<enum_PhysicalBone3D_DampMode>` **angular_damp_mode** = ``0`` :ref:`🔗<class_PhysicalBone3D_property_angular_damp_mode>`
  142. .. rst-class:: classref-property-setget
  143. - |void| **set_angular_damp_mode**\ (\ value\: :ref:`DampMode<enum_PhysicalBone3D_DampMode>`\ )
  144. - :ref:`DampMode<enum_PhysicalBone3D_DampMode>` **get_angular_damp_mode**\ (\ )
  145. Defines how :ref:`angular_damp<class_PhysicalBone3D_property_angular_damp>` is applied. See :ref:`DampMode<enum_PhysicalBone3D_DampMode>` for possible values.
  146. .. rst-class:: classref-item-separator
  147. ----
  148. .. _class_PhysicalBone3D_property_angular_velocity:
  149. .. rst-class:: classref-property
  150. :ref:`Vector3<class_Vector3>` **angular_velocity** = ``Vector3(0, 0, 0)`` :ref:`🔗<class_PhysicalBone3D_property_angular_velocity>`
  151. .. rst-class:: classref-property-setget
  152. - |void| **set_angular_velocity**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  153. - :ref:`Vector3<class_Vector3>` **get_angular_velocity**\ (\ )
  154. The PhysicalBone3D's rotational velocity in *radians* per second.
  155. .. rst-class:: classref-item-separator
  156. ----
  157. .. _class_PhysicalBone3D_property_body_offset:
  158. .. rst-class:: classref-property
  159. :ref:`Transform3D<class_Transform3D>` **body_offset** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` :ref:`🔗<class_PhysicalBone3D_property_body_offset>`
  160. .. rst-class:: classref-property-setget
  161. - |void| **set_body_offset**\ (\ value\: :ref:`Transform3D<class_Transform3D>`\ )
  162. - :ref:`Transform3D<class_Transform3D>` **get_body_offset**\ (\ )
  163. Sets the body's transform.
  164. .. rst-class:: classref-item-separator
  165. ----
  166. .. _class_PhysicalBone3D_property_bounce:
  167. .. rst-class:: classref-property
  168. :ref:`float<class_float>` **bounce** = ``0.0`` :ref:`🔗<class_PhysicalBone3D_property_bounce>`
  169. .. rst-class:: classref-property-setget
  170. - |void| **set_bounce**\ (\ value\: :ref:`float<class_float>`\ )
  171. - :ref:`float<class_float>` **get_bounce**\ (\ )
  172. The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness).
  173. \ **Note:** Even with :ref:`bounce<class_PhysicalBone3D_property_bounce>` set to ``1.0``, some energy will be lost over time due to linear and angular damping. To have a **PhysicalBone3D** that preserves all its energy over time, set :ref:`bounce<class_PhysicalBone3D_property_bounce>` to ``1.0``, :ref:`linear_damp_mode<class_PhysicalBone3D_property_linear_damp_mode>` to :ref:`DAMP_MODE_REPLACE<class_PhysicalBone3D_constant_DAMP_MODE_REPLACE>`, :ref:`linear_damp<class_PhysicalBone3D_property_linear_damp>` to ``0.0``, :ref:`angular_damp_mode<class_PhysicalBone3D_property_angular_damp_mode>` to :ref:`DAMP_MODE_REPLACE<class_PhysicalBone3D_constant_DAMP_MODE_REPLACE>`, and :ref:`angular_damp<class_PhysicalBone3D_property_angular_damp>` to ``0.0``.
  174. .. rst-class:: classref-item-separator
  175. ----
  176. .. _class_PhysicalBone3D_property_can_sleep:
  177. .. rst-class:: classref-property
  178. :ref:`bool<class_bool>` **can_sleep** = ``true`` :ref:`🔗<class_PhysicalBone3D_property_can_sleep>`
  179. .. rst-class:: classref-property-setget
  180. - |void| **set_can_sleep**\ (\ value\: :ref:`bool<class_bool>`\ )
  181. - :ref:`bool<class_bool>` **is_able_to_sleep**\ (\ )
  182. If ``true``, the body is deactivated when there is no movement, so it will not take part in the simulation until it is awakened by an external force.
  183. .. rst-class:: classref-item-separator
  184. ----
  185. .. _class_PhysicalBone3D_property_custom_integrator:
  186. .. rst-class:: classref-property
  187. :ref:`bool<class_bool>` **custom_integrator** = ``false`` :ref:`🔗<class_PhysicalBone3D_property_custom_integrator>`
  188. .. rst-class:: classref-property-setget
  189. - |void| **set_use_custom_integrator**\ (\ value\: :ref:`bool<class_bool>`\ )
  190. - :ref:`bool<class_bool>` **is_using_custom_integrator**\ (\ )
  191. If ``true``, the standard force integration (like gravity or damping) will be disabled for this body. Other than collision response, the body will only move as determined by the :ref:`_integrate_forces<class_PhysicalBone3D_private_method__integrate_forces>` method, if that virtual method is overridden.
  192. Setting this property will call the method :ref:`PhysicsServer3D.body_set_omit_force_integration<class_PhysicsServer3D_method_body_set_omit_force_integration>` internally.
  193. .. rst-class:: classref-item-separator
  194. ----
  195. .. _class_PhysicalBone3D_property_friction:
  196. .. rst-class:: classref-property
  197. :ref:`float<class_float>` **friction** = ``1.0`` :ref:`🔗<class_PhysicalBone3D_property_friction>`
  198. .. rst-class:: classref-property-setget
  199. - |void| **set_friction**\ (\ value\: :ref:`float<class_float>`\ )
  200. - :ref:`float<class_float>` **get_friction**\ (\ )
  201. The body's friction, from ``0`` (frictionless) to ``1`` (max friction).
  202. .. rst-class:: classref-item-separator
  203. ----
  204. .. _class_PhysicalBone3D_property_gravity_scale:
  205. .. rst-class:: classref-property
  206. :ref:`float<class_float>` **gravity_scale** = ``1.0`` :ref:`🔗<class_PhysicalBone3D_property_gravity_scale>`
  207. .. rst-class:: classref-property-setget
  208. - |void| **set_gravity_scale**\ (\ value\: :ref:`float<class_float>`\ )
  209. - :ref:`float<class_float>` **get_gravity_scale**\ (\ )
  210. This is multiplied by the global 3D gravity setting found in **Project > Project Settings > Physics > 3d** to produce the body's gravity. For example, a value of 1 will be normal gravity, 2 will apply double gravity, and 0.5 will apply half gravity to this object.
  211. .. rst-class:: classref-item-separator
  212. ----
  213. .. _class_PhysicalBone3D_property_joint_offset:
  214. .. rst-class:: classref-property
  215. :ref:`Transform3D<class_Transform3D>` **joint_offset** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` :ref:`🔗<class_PhysicalBone3D_property_joint_offset>`
  216. .. rst-class:: classref-property-setget
  217. - |void| **set_joint_offset**\ (\ value\: :ref:`Transform3D<class_Transform3D>`\ )
  218. - :ref:`Transform3D<class_Transform3D>` **get_joint_offset**\ (\ )
  219. Sets the joint's transform.
  220. .. rst-class:: classref-item-separator
  221. ----
  222. .. _class_PhysicalBone3D_property_joint_rotation:
  223. .. rst-class:: classref-property
  224. :ref:`Vector3<class_Vector3>` **joint_rotation** = ``Vector3(0, 0, 0)`` :ref:`🔗<class_PhysicalBone3D_property_joint_rotation>`
  225. .. rst-class:: classref-property-setget
  226. - |void| **set_joint_rotation**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  227. - :ref:`Vector3<class_Vector3>` **get_joint_rotation**\ (\ )
  228. Sets the joint's rotation in radians.
  229. .. rst-class:: classref-item-separator
  230. ----
  231. .. _class_PhysicalBone3D_property_joint_type:
  232. .. rst-class:: classref-property
  233. :ref:`JointType<enum_PhysicalBone3D_JointType>` **joint_type** = ``0`` :ref:`🔗<class_PhysicalBone3D_property_joint_type>`
  234. .. rst-class:: classref-property-setget
  235. - |void| **set_joint_type**\ (\ value\: :ref:`JointType<enum_PhysicalBone3D_JointType>`\ )
  236. - :ref:`JointType<enum_PhysicalBone3D_JointType>` **get_joint_type**\ (\ )
  237. Sets the joint type. See :ref:`JointType<enum_PhysicalBone3D_JointType>` for possible values.
  238. .. rst-class:: classref-item-separator
  239. ----
  240. .. _class_PhysicalBone3D_property_linear_damp:
  241. .. rst-class:: classref-property
  242. :ref:`float<class_float>` **linear_damp** = ``0.0`` :ref:`🔗<class_PhysicalBone3D_property_linear_damp>`
  243. .. rst-class:: classref-property-setget
  244. - |void| **set_linear_damp**\ (\ value\: :ref:`float<class_float>`\ )
  245. - :ref:`float<class_float>` **get_linear_damp**\ (\ )
  246. Damps the body's movement. By default, the body will use the **Default Linear Damp** in **Project > Project Settings > Physics > 3d** or any value override set by an :ref:`Area3D<class_Area3D>` the body is in. Depending on :ref:`linear_damp_mode<class_PhysicalBone3D_property_linear_damp_mode>`, you can set :ref:`linear_damp<class_PhysicalBone3D_property_linear_damp>` to be added to or to replace the body's damping value.
  247. See :ref:`ProjectSettings.physics/3d/default_linear_damp<class_ProjectSettings_property_physics/3d/default_linear_damp>` for more details about damping.
  248. .. rst-class:: classref-item-separator
  249. ----
  250. .. _class_PhysicalBone3D_property_linear_damp_mode:
  251. .. rst-class:: classref-property
  252. :ref:`DampMode<enum_PhysicalBone3D_DampMode>` **linear_damp_mode** = ``0`` :ref:`🔗<class_PhysicalBone3D_property_linear_damp_mode>`
  253. .. rst-class:: classref-property-setget
  254. - |void| **set_linear_damp_mode**\ (\ value\: :ref:`DampMode<enum_PhysicalBone3D_DampMode>`\ )
  255. - :ref:`DampMode<enum_PhysicalBone3D_DampMode>` **get_linear_damp_mode**\ (\ )
  256. Defines how :ref:`linear_damp<class_PhysicalBone3D_property_linear_damp>` is applied. See :ref:`DampMode<enum_PhysicalBone3D_DampMode>` for possible values.
  257. .. rst-class:: classref-item-separator
  258. ----
  259. .. _class_PhysicalBone3D_property_linear_velocity:
  260. .. rst-class:: classref-property
  261. :ref:`Vector3<class_Vector3>` **linear_velocity** = ``Vector3(0, 0, 0)`` :ref:`🔗<class_PhysicalBone3D_property_linear_velocity>`
  262. .. rst-class:: classref-property-setget
  263. - |void| **set_linear_velocity**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  264. - :ref:`Vector3<class_Vector3>` **get_linear_velocity**\ (\ )
  265. The body's linear velocity in units per second. Can be used sporadically, but **don't set this every frame**, because physics may run in another thread and runs at a different granularity. Use :ref:`_integrate_forces<class_PhysicalBone3D_private_method__integrate_forces>` as your process loop for precise control of the body state.
  266. .. rst-class:: classref-item-separator
  267. ----
  268. .. _class_PhysicalBone3D_property_mass:
  269. .. rst-class:: classref-property
  270. :ref:`float<class_float>` **mass** = ``1.0`` :ref:`🔗<class_PhysicalBone3D_property_mass>`
  271. .. rst-class:: classref-property-setget
  272. - |void| **set_mass**\ (\ value\: :ref:`float<class_float>`\ )
  273. - :ref:`float<class_float>` **get_mass**\ (\ )
  274. The body's mass.
  275. .. rst-class:: classref-section-separator
  276. ----
  277. .. rst-class:: classref-descriptions-group
  278. Method Descriptions
  279. -------------------
  280. .. _class_PhysicalBone3D_private_method__integrate_forces:
  281. .. rst-class:: classref-method
  282. |void| **_integrate_forces**\ (\ state\: :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>`\ ) |virtual| :ref:`🔗<class_PhysicalBone3D_private_method__integrate_forces>`
  283. Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default, it is called before the standard force integration, but the :ref:`custom_integrator<class_PhysicalBone3D_property_custom_integrator>` property allows you to disable the standard force integration and do fully custom force integration for a body.
  284. .. rst-class:: classref-item-separator
  285. ----
  286. .. _class_PhysicalBone3D_method_apply_central_impulse:
  287. .. rst-class:: classref-method
  288. |void| **apply_central_impulse**\ (\ impulse\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicalBone3D_method_apply_central_impulse>`
  289. .. container:: contribute
  290. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  291. .. rst-class:: classref-item-separator
  292. ----
  293. .. _class_PhysicalBone3D_method_apply_impulse:
  294. .. rst-class:: classref-method
  295. |void| **apply_impulse**\ (\ impulse\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) :ref:`🔗<class_PhysicalBone3D_method_apply_impulse>`
  296. .. container:: contribute
  297. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  298. .. rst-class:: classref-item-separator
  299. ----
  300. .. _class_PhysicalBone3D_method_get_bone_id:
  301. .. rst-class:: classref-method
  302. :ref:`int<class_int>` **get_bone_id**\ (\ ) |const| :ref:`🔗<class_PhysicalBone3D_method_get_bone_id>`
  303. .. container:: contribute
  304. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  305. .. rst-class:: classref-item-separator
  306. ----
  307. .. _class_PhysicalBone3D_method_get_simulate_physics:
  308. .. rst-class:: classref-method
  309. :ref:`bool<class_bool>` **get_simulate_physics**\ (\ ) :ref:`🔗<class_PhysicalBone3D_method_get_simulate_physics>`
  310. .. container:: contribute
  311. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  312. .. rst-class:: classref-item-separator
  313. ----
  314. .. _class_PhysicalBone3D_method_is_simulating_physics:
  315. .. rst-class:: classref-method
  316. :ref:`bool<class_bool>` **is_simulating_physics**\ (\ ) :ref:`🔗<class_PhysicalBone3D_method_is_simulating_physics>`
  317. .. container:: contribute
  318. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  319. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  320. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  321. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  322. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  323. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  324. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  325. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  326. .. |void| replace:: :abbr:`void (No return value.)`