class_rigidbody3d.rst 53 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RigidBody3D.xml.
  6. .. _class_RigidBody3D:
  7. RigidBody3D
  8. ===========
  9. **Inherits:** :ref:`PhysicsBody3D<class_PhysicsBody3D>` **<** :ref:`CollisionObject3D<class_CollisionObject3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`VehicleBody3D<class_VehicleBody3D>`
  11. A 3D physics body that is moved by a physics simulation.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. **RigidBody3D** implements full 3D physics. It cannot be controlled directly, instead, you must apply forces to it (gravity, impulses, etc.), and the physics simulation will calculate the resulting movement, rotation, react to collisions, and affect other physics bodies in its path.
  16. The body's behavior can be adjusted via :ref:`lock_rotation<class_RigidBody3D_property_lock_rotation>`, :ref:`freeze<class_RigidBody3D_property_freeze>`, and :ref:`freeze_mode<class_RigidBody3D_property_freeze_mode>`. By changing various properties of the object, such as :ref:`mass<class_RigidBody3D_property_mass>`, you can control how the physics simulation acts on it.
  17. A rigid body will always maintain its shape and size, even when forces are applied to it. It is useful for objects that can be interacted with in an environment, such as a tree that can be knocked over or a stack of crates that can be pushed around.
  18. If you need to override the default physics behavior, you can write a custom force integration function. See :ref:`custom_integrator<class_RigidBody3D_property_custom_integrator>`.
  19. \ **Note:** Changing the 3D transform or :ref:`linear_velocity<class_RigidBody3D_property_linear_velocity>` of a **RigidBody3D** very often may lead to some unpredictable behaviors. If you need to directly affect the body, prefer :ref:`_integrate_forces<class_RigidBody3D_private_method__integrate_forces>` as it allows you to directly access the physics state.
  20. .. rst-class:: classref-introduction-group
  21. Tutorials
  22. ---------
  23. - :doc:`Physics introduction <../tutorials/physics/physics_introduction>`
  24. - `3D Truck Town Demo <https://godotengine.org/asset-library/asset/2752>`__
  25. - `3D Physics Tests Demo <https://godotengine.org/asset-library/asset/2747>`__
  26. .. rst-class:: classref-reftable-group
  27. Properties
  28. ----------
  29. .. table::
  30. :widths: auto
  31. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  32. | :ref:`float<class_float>` | :ref:`angular_damp<class_RigidBody3D_property_angular_damp>` | ``0.0`` |
  33. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  34. | :ref:`DampMode<enum_RigidBody3D_DampMode>` | :ref:`angular_damp_mode<class_RigidBody3D_property_angular_damp_mode>` | ``0`` |
  35. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  36. | :ref:`Vector3<class_Vector3>` | :ref:`angular_velocity<class_RigidBody3D_property_angular_velocity>` | ``Vector3(0, 0, 0)`` |
  37. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  38. | :ref:`bool<class_bool>` | :ref:`can_sleep<class_RigidBody3D_property_can_sleep>` | ``true`` |
  39. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  40. | :ref:`Vector3<class_Vector3>` | :ref:`center_of_mass<class_RigidBody3D_property_center_of_mass>` | ``Vector3(0, 0, 0)`` |
  41. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  42. | :ref:`CenterOfMassMode<enum_RigidBody3D_CenterOfMassMode>` | :ref:`center_of_mass_mode<class_RigidBody3D_property_center_of_mass_mode>` | ``0`` |
  43. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  44. | :ref:`Vector3<class_Vector3>` | :ref:`constant_force<class_RigidBody3D_property_constant_force>` | ``Vector3(0, 0, 0)`` |
  45. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  46. | :ref:`Vector3<class_Vector3>` | :ref:`constant_torque<class_RigidBody3D_property_constant_torque>` | ``Vector3(0, 0, 0)`` |
  47. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  48. | :ref:`bool<class_bool>` | :ref:`contact_monitor<class_RigidBody3D_property_contact_monitor>` | ``false`` |
  49. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  50. | :ref:`bool<class_bool>` | :ref:`continuous_cd<class_RigidBody3D_property_continuous_cd>` | ``false`` |
  51. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  52. | :ref:`bool<class_bool>` | :ref:`custom_integrator<class_RigidBody3D_property_custom_integrator>` | ``false`` |
  53. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  54. | :ref:`bool<class_bool>` | :ref:`freeze<class_RigidBody3D_property_freeze>` | ``false`` |
  55. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  56. | :ref:`FreezeMode<enum_RigidBody3D_FreezeMode>` | :ref:`freeze_mode<class_RigidBody3D_property_freeze_mode>` | ``0`` |
  57. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  58. | :ref:`float<class_float>` | :ref:`gravity_scale<class_RigidBody3D_property_gravity_scale>` | ``1.0`` |
  59. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  60. | :ref:`Vector3<class_Vector3>` | :ref:`inertia<class_RigidBody3D_property_inertia>` | ``Vector3(0, 0, 0)`` |
  61. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  62. | :ref:`float<class_float>` | :ref:`linear_damp<class_RigidBody3D_property_linear_damp>` | ``0.0`` |
  63. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  64. | :ref:`DampMode<enum_RigidBody3D_DampMode>` | :ref:`linear_damp_mode<class_RigidBody3D_property_linear_damp_mode>` | ``0`` |
  65. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  66. | :ref:`Vector3<class_Vector3>` | :ref:`linear_velocity<class_RigidBody3D_property_linear_velocity>` | ``Vector3(0, 0, 0)`` |
  67. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  68. | :ref:`bool<class_bool>` | :ref:`lock_rotation<class_RigidBody3D_property_lock_rotation>` | ``false`` |
  69. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  70. | :ref:`float<class_float>` | :ref:`mass<class_RigidBody3D_property_mass>` | ``1.0`` |
  71. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  72. | :ref:`int<class_int>` | :ref:`max_contacts_reported<class_RigidBody3D_property_max_contacts_reported>` | ``0`` |
  73. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  74. | :ref:`PhysicsMaterial<class_PhysicsMaterial>` | :ref:`physics_material_override<class_RigidBody3D_property_physics_material_override>` | |
  75. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  76. | :ref:`bool<class_bool>` | :ref:`sleeping<class_RigidBody3D_property_sleeping>` | ``false`` |
  77. +------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------------+
  78. .. rst-class:: classref-reftable-group
  79. Methods
  80. -------
  81. .. table::
  82. :widths: auto
  83. +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | |void| | :ref:`_integrate_forces<class_RigidBody3D_private_method__integrate_forces>`\ (\ state\: :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>`\ ) |virtual| |
  85. +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | |void| | :ref:`add_constant_central_force<class_RigidBody3D_method_add_constant_central_force>`\ (\ force\: :ref:`Vector3<class_Vector3>`\ ) |
  87. +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | |void| | :ref:`add_constant_force<class_RigidBody3D_method_add_constant_force>`\ (\ force\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) |
  89. +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | |void| | :ref:`add_constant_torque<class_RigidBody3D_method_add_constant_torque>`\ (\ torque\: :ref:`Vector3<class_Vector3>`\ ) |
  91. +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | |void| | :ref:`apply_central_force<class_RigidBody3D_method_apply_central_force>`\ (\ force\: :ref:`Vector3<class_Vector3>`\ ) |
  93. +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | |void| | :ref:`apply_central_impulse<class_RigidBody3D_method_apply_central_impulse>`\ (\ impulse\: :ref:`Vector3<class_Vector3>`\ ) |
  95. +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | |void| | :ref:`apply_force<class_RigidBody3D_method_apply_force>`\ (\ force\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) |
  97. +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | |void| | :ref:`apply_impulse<class_RigidBody3D_method_apply_impulse>`\ (\ impulse\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) |
  99. +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  100. | |void| | :ref:`apply_torque<class_RigidBody3D_method_apply_torque>`\ (\ torque\: :ref:`Vector3<class_Vector3>`\ ) |
  101. +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  102. | |void| | :ref:`apply_torque_impulse<class_RigidBody3D_method_apply_torque_impulse>`\ (\ impulse\: :ref:`Vector3<class_Vector3>`\ ) |
  103. +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  104. | :ref:`Array<class_Array>`\[:ref:`Node3D<class_Node3D>`\] | :ref:`get_colliding_bodies<class_RigidBody3D_method_get_colliding_bodies>`\ (\ ) |const| |
  105. +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  106. | :ref:`int<class_int>` | :ref:`get_contact_count<class_RigidBody3D_method_get_contact_count>`\ (\ ) |const| |
  107. +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  108. | :ref:`Basis<class_Basis>` | :ref:`get_inverse_inertia_tensor<class_RigidBody3D_method_get_inverse_inertia_tensor>`\ (\ ) |const| |
  109. +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  110. | |void| | :ref:`set_axis_velocity<class_RigidBody3D_method_set_axis_velocity>`\ (\ axis_velocity\: :ref:`Vector3<class_Vector3>`\ ) |
  111. +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  112. .. rst-class:: classref-section-separator
  113. ----
  114. .. rst-class:: classref-descriptions-group
  115. Signals
  116. -------
  117. .. _class_RigidBody3D_signal_body_entered:
  118. .. rst-class:: classref-signal
  119. **body_entered**\ (\ body\: :ref:`Node<class_Node>`\ ) :ref:`🔗<class_RigidBody3D_signal_body_entered>`
  120. Emitted when a collision with another :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>` occurs. Requires :ref:`contact_monitor<class_RigidBody3D_property_contact_monitor>` to be set to ``true`` and :ref:`max_contacts_reported<class_RigidBody3D_property_max_contacts_reported>` to be set high enough to detect all the collisions. :ref:`GridMap<class_GridMap>`\ s are detected if the :ref:`MeshLibrary<class_MeshLibrary>` has Collision :ref:`Shape3D<class_Shape3D>`\ s.
  121. \ ``body`` the :ref:`Node<class_Node>`, if it exists in the tree, of the other :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>`.
  122. .. rst-class:: classref-item-separator
  123. ----
  124. .. _class_RigidBody3D_signal_body_exited:
  125. .. rst-class:: classref-signal
  126. **body_exited**\ (\ body\: :ref:`Node<class_Node>`\ ) :ref:`🔗<class_RigidBody3D_signal_body_exited>`
  127. Emitted when the collision with another :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>` ends. Requires :ref:`contact_monitor<class_RigidBody3D_property_contact_monitor>` to be set to ``true`` and :ref:`max_contacts_reported<class_RigidBody3D_property_max_contacts_reported>` to be set high enough to detect all the collisions. :ref:`GridMap<class_GridMap>`\ s are detected if the :ref:`MeshLibrary<class_MeshLibrary>` has Collision :ref:`Shape3D<class_Shape3D>`\ s.
  128. \ ``body`` the :ref:`Node<class_Node>`, if it exists in the tree, of the other :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>`.
  129. .. rst-class:: classref-item-separator
  130. ----
  131. .. _class_RigidBody3D_signal_body_shape_entered:
  132. .. rst-class:: classref-signal
  133. **body_shape_entered**\ (\ body_rid\: :ref:`RID<class_RID>`, body\: :ref:`Node<class_Node>`, body_shape_index\: :ref:`int<class_int>`, local_shape_index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RigidBody3D_signal_body_shape_entered>`
  134. Emitted when one of this RigidBody3D's :ref:`Shape3D<class_Shape3D>`\ s collides with another :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>`'s :ref:`Shape3D<class_Shape3D>`\ s. Requires :ref:`contact_monitor<class_RigidBody3D_property_contact_monitor>` to be set to ``true`` and :ref:`max_contacts_reported<class_RigidBody3D_property_max_contacts_reported>` to be set high enough to detect all the collisions. :ref:`GridMap<class_GridMap>`\ s are detected if the :ref:`MeshLibrary<class_MeshLibrary>` has Collision :ref:`Shape3D<class_Shape3D>`\ s.
  135. \ ``body_rid`` the :ref:`RID<class_RID>` of the other :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`MeshLibrary<class_MeshLibrary>`'s :ref:`CollisionObject3D<class_CollisionObject3D>` used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.
  136. \ ``body`` the :ref:`Node<class_Node>`, if it exists in the tree, of the other :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>`.
  137. \ ``body_shape_index`` the index of the :ref:`Shape3D<class_Shape3D>` of the other :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>` used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`. Get the :ref:`CollisionShape3D<class_CollisionShape3D>` node with ``body.shape_owner_get_owner(body.shape_find_owner(body_shape_index))``.
  138. \ ``local_shape_index`` the index of the :ref:`Shape3D<class_Shape3D>` of this RigidBody3D used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`. Get the :ref:`CollisionShape3D<class_CollisionShape3D>` node with ``self.shape_owner_get_owner(self.shape_find_owner(local_shape_index))``.
  139. .. rst-class:: classref-item-separator
  140. ----
  141. .. _class_RigidBody3D_signal_body_shape_exited:
  142. .. rst-class:: classref-signal
  143. **body_shape_exited**\ (\ body_rid\: :ref:`RID<class_RID>`, body\: :ref:`Node<class_Node>`, body_shape_index\: :ref:`int<class_int>`, local_shape_index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RigidBody3D_signal_body_shape_exited>`
  144. Emitted when the collision between one of this RigidBody3D's :ref:`Shape3D<class_Shape3D>`\ s and another :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>`'s :ref:`Shape3D<class_Shape3D>`\ s ends. Requires :ref:`contact_monitor<class_RigidBody3D_property_contact_monitor>` to be set to ``true`` and :ref:`max_contacts_reported<class_RigidBody3D_property_max_contacts_reported>` to be set high enough to detect all the collisions. :ref:`GridMap<class_GridMap>`\ s are detected if the :ref:`MeshLibrary<class_MeshLibrary>` has Collision :ref:`Shape3D<class_Shape3D>`\ s.
  145. \ ``body_rid`` the :ref:`RID<class_RID>` of the other :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`MeshLibrary<class_MeshLibrary>`'s :ref:`CollisionObject3D<class_CollisionObject3D>` used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`. :ref:`GridMap<class_GridMap>`\ s are detected if the Meshes have :ref:`Shape3D<class_Shape3D>`\ s.
  146. \ ``body`` the :ref:`Node<class_Node>`, if it exists in the tree, of the other :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>`.
  147. \ ``body_shape_index`` the index of the :ref:`Shape3D<class_Shape3D>` of the other :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>` used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`. Get the :ref:`CollisionShape3D<class_CollisionShape3D>` node with ``body.shape_owner_get_owner(body.shape_find_owner(body_shape_index))``.
  148. \ ``local_shape_index`` the index of the :ref:`Shape3D<class_Shape3D>` of this RigidBody3D used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`. Get the :ref:`CollisionShape3D<class_CollisionShape3D>` node with ``self.shape_owner_get_owner(self.shape_find_owner(local_shape_index))``.
  149. .. rst-class:: classref-item-separator
  150. ----
  151. .. _class_RigidBody3D_signal_sleeping_state_changed:
  152. .. rst-class:: classref-signal
  153. **sleeping_state_changed**\ (\ ) :ref:`🔗<class_RigidBody3D_signal_sleeping_state_changed>`
  154. Emitted when the physics engine changes the body's sleeping state.
  155. \ **Note:** Changing the value :ref:`sleeping<class_RigidBody3D_property_sleeping>` will not trigger this signal. It is only emitted if the sleeping state is changed by the physics engine or ``emit_signal("sleeping_state_changed")`` is used.
  156. .. rst-class:: classref-section-separator
  157. ----
  158. .. rst-class:: classref-descriptions-group
  159. Enumerations
  160. ------------
  161. .. _enum_RigidBody3D_FreezeMode:
  162. .. rst-class:: classref-enumeration
  163. enum **FreezeMode**: :ref:`🔗<enum_RigidBody3D_FreezeMode>`
  164. .. _class_RigidBody3D_constant_FREEZE_MODE_STATIC:
  165. .. rst-class:: classref-enumeration-constant
  166. :ref:`FreezeMode<enum_RigidBody3D_FreezeMode>` **FREEZE_MODE_STATIC** = ``0``
  167. Static body freeze mode (default). The body is not affected by gravity and forces. It can be only moved by user code and doesn't collide with other bodies along its path.
  168. .. _class_RigidBody3D_constant_FREEZE_MODE_KINEMATIC:
  169. .. rst-class:: classref-enumeration-constant
  170. :ref:`FreezeMode<enum_RigidBody3D_FreezeMode>` **FREEZE_MODE_KINEMATIC** = ``1``
  171. Kinematic body freeze mode. Similar to :ref:`FREEZE_MODE_STATIC<class_RigidBody3D_constant_FREEZE_MODE_STATIC>`, but collides with other bodies along its path when moved. Useful for a frozen body that needs to be animated.
  172. .. rst-class:: classref-item-separator
  173. ----
  174. .. _enum_RigidBody3D_CenterOfMassMode:
  175. .. rst-class:: classref-enumeration
  176. enum **CenterOfMassMode**: :ref:`🔗<enum_RigidBody3D_CenterOfMassMode>`
  177. .. _class_RigidBody3D_constant_CENTER_OF_MASS_MODE_AUTO:
  178. .. rst-class:: classref-enumeration-constant
  179. :ref:`CenterOfMassMode<enum_RigidBody3D_CenterOfMassMode>` **CENTER_OF_MASS_MODE_AUTO** = ``0``
  180. In this mode, the body's center of mass is calculated automatically based on its shapes. This assumes that the shapes' origins are also their center of mass.
  181. .. _class_RigidBody3D_constant_CENTER_OF_MASS_MODE_CUSTOM:
  182. .. rst-class:: classref-enumeration-constant
  183. :ref:`CenterOfMassMode<enum_RigidBody3D_CenterOfMassMode>` **CENTER_OF_MASS_MODE_CUSTOM** = ``1``
  184. In this mode, the body's center of mass is set through :ref:`center_of_mass<class_RigidBody3D_property_center_of_mass>`. Defaults to the body's origin position.
  185. .. rst-class:: classref-item-separator
  186. ----
  187. .. _enum_RigidBody3D_DampMode:
  188. .. rst-class:: classref-enumeration
  189. enum **DampMode**: :ref:`🔗<enum_RigidBody3D_DampMode>`
  190. .. _class_RigidBody3D_constant_DAMP_MODE_COMBINE:
  191. .. rst-class:: classref-enumeration-constant
  192. :ref:`DampMode<enum_RigidBody3D_DampMode>` **DAMP_MODE_COMBINE** = ``0``
  193. In this mode, the body's damping value is added to any value set in areas or the default value.
  194. .. _class_RigidBody3D_constant_DAMP_MODE_REPLACE:
  195. .. rst-class:: classref-enumeration-constant
  196. :ref:`DampMode<enum_RigidBody3D_DampMode>` **DAMP_MODE_REPLACE** = ``1``
  197. In this mode, the body's damping value replaces any value set in areas or the default value.
  198. .. rst-class:: classref-section-separator
  199. ----
  200. .. rst-class:: classref-descriptions-group
  201. Property Descriptions
  202. ---------------------
  203. .. _class_RigidBody3D_property_angular_damp:
  204. .. rst-class:: classref-property
  205. :ref:`float<class_float>` **angular_damp** = ``0.0`` :ref:`🔗<class_RigidBody3D_property_angular_damp>`
  206. .. rst-class:: classref-property-setget
  207. - |void| **set_angular_damp**\ (\ value\: :ref:`float<class_float>`\ )
  208. - :ref:`float<class_float>` **get_angular_damp**\ (\ )
  209. Damps the body's rotation. By default, the body will use the :ref:`ProjectSettings.physics/3d/default_angular_damp<class_ProjectSettings_property_physics/3d/default_angular_damp>` project setting or any value override set by an :ref:`Area3D<class_Area3D>` the body is in. Depending on :ref:`angular_damp_mode<class_RigidBody3D_property_angular_damp_mode>`, you can set :ref:`angular_damp<class_RigidBody3D_property_angular_damp>` to be added to or to replace the body's damping value.
  210. See :ref:`ProjectSettings.physics/3d/default_angular_damp<class_ProjectSettings_property_physics/3d/default_angular_damp>` for more details about damping.
  211. .. rst-class:: classref-item-separator
  212. ----
  213. .. _class_RigidBody3D_property_angular_damp_mode:
  214. .. rst-class:: classref-property
  215. :ref:`DampMode<enum_RigidBody3D_DampMode>` **angular_damp_mode** = ``0`` :ref:`🔗<class_RigidBody3D_property_angular_damp_mode>`
  216. .. rst-class:: classref-property-setget
  217. - |void| **set_angular_damp_mode**\ (\ value\: :ref:`DampMode<enum_RigidBody3D_DampMode>`\ )
  218. - :ref:`DampMode<enum_RigidBody3D_DampMode>` **get_angular_damp_mode**\ (\ )
  219. Defines how :ref:`angular_damp<class_RigidBody3D_property_angular_damp>` is applied. See :ref:`DampMode<enum_RigidBody3D_DampMode>` for possible values.
  220. .. rst-class:: classref-item-separator
  221. ----
  222. .. _class_RigidBody3D_property_angular_velocity:
  223. .. rst-class:: classref-property
  224. :ref:`Vector3<class_Vector3>` **angular_velocity** = ``Vector3(0, 0, 0)`` :ref:`🔗<class_RigidBody3D_property_angular_velocity>`
  225. .. rst-class:: classref-property-setget
  226. - |void| **set_angular_velocity**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  227. - :ref:`Vector3<class_Vector3>` **get_angular_velocity**\ (\ )
  228. The RigidBody3D's rotational velocity in *radians* per second.
  229. .. rst-class:: classref-item-separator
  230. ----
  231. .. _class_RigidBody3D_property_can_sleep:
  232. .. rst-class:: classref-property
  233. :ref:`bool<class_bool>` **can_sleep** = ``true`` :ref:`🔗<class_RigidBody3D_property_can_sleep>`
  234. .. rst-class:: classref-property-setget
  235. - |void| **set_can_sleep**\ (\ value\: :ref:`bool<class_bool>`\ )
  236. - :ref:`bool<class_bool>` **is_able_to_sleep**\ (\ )
  237. If ``true``, the body can enter sleep mode when there is no movement. See :ref:`sleeping<class_RigidBody3D_property_sleeping>`.
  238. .. rst-class:: classref-item-separator
  239. ----
  240. .. _class_RigidBody3D_property_center_of_mass:
  241. .. rst-class:: classref-property
  242. :ref:`Vector3<class_Vector3>` **center_of_mass** = ``Vector3(0, 0, 0)`` :ref:`🔗<class_RigidBody3D_property_center_of_mass>`
  243. .. rst-class:: classref-property-setget
  244. - |void| **set_center_of_mass**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  245. - :ref:`Vector3<class_Vector3>` **get_center_of_mass**\ (\ )
  246. The body's custom center of mass, relative to the body's origin position, when :ref:`center_of_mass_mode<class_RigidBody3D_property_center_of_mass_mode>` is set to :ref:`CENTER_OF_MASS_MODE_CUSTOM<class_RigidBody3D_constant_CENTER_OF_MASS_MODE_CUSTOM>`. This is the balanced point of the body, where applied forces only cause linear acceleration. Applying forces outside of the center of mass causes angular acceleration.
  247. When :ref:`center_of_mass_mode<class_RigidBody3D_property_center_of_mass_mode>` is set to :ref:`CENTER_OF_MASS_MODE_AUTO<class_RigidBody3D_constant_CENTER_OF_MASS_MODE_AUTO>` (default value), the center of mass is automatically computed.
  248. .. rst-class:: classref-item-separator
  249. ----
  250. .. _class_RigidBody3D_property_center_of_mass_mode:
  251. .. rst-class:: classref-property
  252. :ref:`CenterOfMassMode<enum_RigidBody3D_CenterOfMassMode>` **center_of_mass_mode** = ``0`` :ref:`🔗<class_RigidBody3D_property_center_of_mass_mode>`
  253. .. rst-class:: classref-property-setget
  254. - |void| **set_center_of_mass_mode**\ (\ value\: :ref:`CenterOfMassMode<enum_RigidBody3D_CenterOfMassMode>`\ )
  255. - :ref:`CenterOfMassMode<enum_RigidBody3D_CenterOfMassMode>` **get_center_of_mass_mode**\ (\ )
  256. Defines the way the body's center of mass is set. See :ref:`CenterOfMassMode<enum_RigidBody3D_CenterOfMassMode>` for possible values.
  257. .. rst-class:: classref-item-separator
  258. ----
  259. .. _class_RigidBody3D_property_constant_force:
  260. .. rst-class:: classref-property
  261. :ref:`Vector3<class_Vector3>` **constant_force** = ``Vector3(0, 0, 0)`` :ref:`🔗<class_RigidBody3D_property_constant_force>`
  262. .. rst-class:: classref-property-setget
  263. - |void| **set_constant_force**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  264. - :ref:`Vector3<class_Vector3>` **get_constant_force**\ (\ )
  265. The body's total constant positional forces applied during each physics update.
  266. See :ref:`add_constant_force<class_RigidBody3D_method_add_constant_force>` and :ref:`add_constant_central_force<class_RigidBody3D_method_add_constant_central_force>`.
  267. .. rst-class:: classref-item-separator
  268. ----
  269. .. _class_RigidBody3D_property_constant_torque:
  270. .. rst-class:: classref-property
  271. :ref:`Vector3<class_Vector3>` **constant_torque** = ``Vector3(0, 0, 0)`` :ref:`🔗<class_RigidBody3D_property_constant_torque>`
  272. .. rst-class:: classref-property-setget
  273. - |void| **set_constant_torque**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  274. - :ref:`Vector3<class_Vector3>` **get_constant_torque**\ (\ )
  275. The body's total constant rotational forces applied during each physics update.
  276. See :ref:`add_constant_torque<class_RigidBody3D_method_add_constant_torque>`.
  277. .. rst-class:: classref-item-separator
  278. ----
  279. .. _class_RigidBody3D_property_contact_monitor:
  280. .. rst-class:: classref-property
  281. :ref:`bool<class_bool>` **contact_monitor** = ``false`` :ref:`🔗<class_RigidBody3D_property_contact_monitor>`
  282. .. rst-class:: classref-property-setget
  283. - |void| **set_contact_monitor**\ (\ value\: :ref:`bool<class_bool>`\ )
  284. - :ref:`bool<class_bool>` **is_contact_monitor_enabled**\ (\ )
  285. If ``true``, the RigidBody3D will emit signals when it collides with another body.
  286. \ **Note:** By default the maximum contacts reported is set to 0, meaning nothing will be recorded, see :ref:`max_contacts_reported<class_RigidBody3D_property_max_contacts_reported>`.
  287. .. rst-class:: classref-item-separator
  288. ----
  289. .. _class_RigidBody3D_property_continuous_cd:
  290. .. rst-class:: classref-property
  291. :ref:`bool<class_bool>` **continuous_cd** = ``false`` :ref:`🔗<class_RigidBody3D_property_continuous_cd>`
  292. .. rst-class:: classref-property-setget
  293. - |void| **set_use_continuous_collision_detection**\ (\ value\: :ref:`bool<class_bool>`\ )
  294. - :ref:`bool<class_bool>` **is_using_continuous_collision_detection**\ (\ )
  295. If ``true``, continuous collision detection is used.
  296. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. Continuous collision detection is more precise, and misses fewer impacts by small, fast-moving objects. Not using continuous collision detection is faster to compute, but can miss small, fast-moving objects.
  297. .. rst-class:: classref-item-separator
  298. ----
  299. .. _class_RigidBody3D_property_custom_integrator:
  300. .. rst-class:: classref-property
  301. :ref:`bool<class_bool>` **custom_integrator** = ``false`` :ref:`🔗<class_RigidBody3D_property_custom_integrator>`
  302. .. rst-class:: classref-property-setget
  303. - |void| **set_use_custom_integrator**\ (\ value\: :ref:`bool<class_bool>`\ )
  304. - :ref:`bool<class_bool>` **is_using_custom_integrator**\ (\ )
  305. 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_RigidBody3D_private_method__integrate_forces>` method, if that virtual method is overridden.
  306. Setting this property will call the method :ref:`PhysicsServer3D.body_set_omit_force_integration<class_PhysicsServer3D_method_body_set_omit_force_integration>` internally.
  307. .. rst-class:: classref-item-separator
  308. ----
  309. .. _class_RigidBody3D_property_freeze:
  310. .. rst-class:: classref-property
  311. :ref:`bool<class_bool>` **freeze** = ``false`` :ref:`🔗<class_RigidBody3D_property_freeze>`
  312. .. rst-class:: classref-property-setget
  313. - |void| **set_freeze_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
  314. - :ref:`bool<class_bool>` **is_freeze_enabled**\ (\ )
  315. If ``true``, the body is frozen. Gravity and forces are not applied anymore.
  316. See :ref:`freeze_mode<class_RigidBody3D_property_freeze_mode>` to set the body's behavior when frozen.
  317. For a body that is always frozen, use :ref:`StaticBody3D<class_StaticBody3D>` or :ref:`AnimatableBody3D<class_AnimatableBody3D>` instead.
  318. .. rst-class:: classref-item-separator
  319. ----
  320. .. _class_RigidBody3D_property_freeze_mode:
  321. .. rst-class:: classref-property
  322. :ref:`FreezeMode<enum_RigidBody3D_FreezeMode>` **freeze_mode** = ``0`` :ref:`🔗<class_RigidBody3D_property_freeze_mode>`
  323. .. rst-class:: classref-property-setget
  324. - |void| **set_freeze_mode**\ (\ value\: :ref:`FreezeMode<enum_RigidBody3D_FreezeMode>`\ )
  325. - :ref:`FreezeMode<enum_RigidBody3D_FreezeMode>` **get_freeze_mode**\ (\ )
  326. The body's freeze mode. Can be used to set the body's behavior when :ref:`freeze<class_RigidBody3D_property_freeze>` is enabled. See :ref:`FreezeMode<enum_RigidBody3D_FreezeMode>` for possible values.
  327. For a body that is always frozen, use :ref:`StaticBody3D<class_StaticBody3D>` or :ref:`AnimatableBody3D<class_AnimatableBody3D>` instead.
  328. .. rst-class:: classref-item-separator
  329. ----
  330. .. _class_RigidBody3D_property_gravity_scale:
  331. .. rst-class:: classref-property
  332. :ref:`float<class_float>` **gravity_scale** = ``1.0`` :ref:`🔗<class_RigidBody3D_property_gravity_scale>`
  333. .. rst-class:: classref-property-setget
  334. - |void| **set_gravity_scale**\ (\ value\: :ref:`float<class_float>`\ )
  335. - :ref:`float<class_float>` **get_gravity_scale**\ (\ )
  336. This is multiplied by :ref:`ProjectSettings.physics/3d/default_gravity<class_ProjectSettings_property_physics/3d/default_gravity>` to produce this body's gravity. For example, a value of ``1.0`` will apply normal gravity, ``2.0`` will apply double the gravity, and ``0.5`` will apply half the gravity to this body.
  337. .. rst-class:: classref-item-separator
  338. ----
  339. .. _class_RigidBody3D_property_inertia:
  340. .. rst-class:: classref-property
  341. :ref:`Vector3<class_Vector3>` **inertia** = ``Vector3(0, 0, 0)`` :ref:`🔗<class_RigidBody3D_property_inertia>`
  342. .. rst-class:: classref-property-setget
  343. - |void| **set_inertia**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  344. - :ref:`Vector3<class_Vector3>` **get_inertia**\ (\ )
  345. The body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body on each axis. The moment of inertia is usually computed automatically from the mass and the shapes, but this property allows you to set a custom value.
  346. If set to :ref:`Vector3.ZERO<class_Vector3_constant_ZERO>`, inertia is automatically computed (default value).
  347. \ **Note:** This value does not change when inertia is automatically computed. Use :ref:`PhysicsServer3D<class_PhysicsServer3D>` to get the computed inertia.
  348. .. tabs::
  349. .. code-tab:: gdscript
  350. @onready var ball = $Ball
  351. func get_ball_inertia():
  352. return PhysicsServer3D.body_get_direct_state(ball.get_rid()).inverse_inertia.inverse()
  353. .. code-tab:: csharp
  354. private RigidBody3D _ball;
  355. public override void _Ready()
  356. {
  357. _ball = GetNode<RigidBody3D>("Ball");
  358. }
  359. private Vector3 GetBallInertia()
  360. {
  361. return PhysicsServer3D.BodyGetDirectState(_ball.GetRid()).InverseInertia.Inverse();
  362. }
  363. .. rst-class:: classref-item-separator
  364. ----
  365. .. _class_RigidBody3D_property_linear_damp:
  366. .. rst-class:: classref-property
  367. :ref:`float<class_float>` **linear_damp** = ``0.0`` :ref:`🔗<class_RigidBody3D_property_linear_damp>`
  368. .. rst-class:: classref-property-setget
  369. - |void| **set_linear_damp**\ (\ value\: :ref:`float<class_float>`\ )
  370. - :ref:`float<class_float>` **get_linear_damp**\ (\ )
  371. Damps the body's movement. By default, the body will use the :ref:`ProjectSettings.physics/3d/default_linear_damp<class_ProjectSettings_property_physics/3d/default_linear_damp>` project setting or any value override set by an :ref:`Area3D<class_Area3D>` the body is in. Depending on :ref:`linear_damp_mode<class_RigidBody3D_property_linear_damp_mode>`, you can set :ref:`linear_damp<class_RigidBody3D_property_linear_damp>` to be added to or to replace the body's damping value.
  372. See :ref:`ProjectSettings.physics/3d/default_linear_damp<class_ProjectSettings_property_physics/3d/default_linear_damp>` for more details about damping.
  373. .. rst-class:: classref-item-separator
  374. ----
  375. .. _class_RigidBody3D_property_linear_damp_mode:
  376. .. rst-class:: classref-property
  377. :ref:`DampMode<enum_RigidBody3D_DampMode>` **linear_damp_mode** = ``0`` :ref:`🔗<class_RigidBody3D_property_linear_damp_mode>`
  378. .. rst-class:: classref-property-setget
  379. - |void| **set_linear_damp_mode**\ (\ value\: :ref:`DampMode<enum_RigidBody3D_DampMode>`\ )
  380. - :ref:`DampMode<enum_RigidBody3D_DampMode>` **get_linear_damp_mode**\ (\ )
  381. Defines how :ref:`linear_damp<class_RigidBody3D_property_linear_damp>` is applied. See :ref:`DampMode<enum_RigidBody3D_DampMode>` for possible values.
  382. .. rst-class:: classref-item-separator
  383. ----
  384. .. _class_RigidBody3D_property_linear_velocity:
  385. .. rst-class:: classref-property
  386. :ref:`Vector3<class_Vector3>` **linear_velocity** = ``Vector3(0, 0, 0)`` :ref:`🔗<class_RigidBody3D_property_linear_velocity>`
  387. .. rst-class:: classref-property-setget
  388. - |void| **set_linear_velocity**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  389. - :ref:`Vector3<class_Vector3>` **get_linear_velocity**\ (\ )
  390. 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_RigidBody3D_private_method__integrate_forces>` as your process loop for precise control of the body state.
  391. .. rst-class:: classref-item-separator
  392. ----
  393. .. _class_RigidBody3D_property_lock_rotation:
  394. .. rst-class:: classref-property
  395. :ref:`bool<class_bool>` **lock_rotation** = ``false`` :ref:`🔗<class_RigidBody3D_property_lock_rotation>`
  396. .. rst-class:: classref-property-setget
  397. - |void| **set_lock_rotation_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
  398. - :ref:`bool<class_bool>` **is_lock_rotation_enabled**\ (\ )
  399. If ``true``, the body cannot rotate. Gravity and forces only apply linear movement.
  400. .. rst-class:: classref-item-separator
  401. ----
  402. .. _class_RigidBody3D_property_mass:
  403. .. rst-class:: classref-property
  404. :ref:`float<class_float>` **mass** = ``1.0`` :ref:`🔗<class_RigidBody3D_property_mass>`
  405. .. rst-class:: classref-property-setget
  406. - |void| **set_mass**\ (\ value\: :ref:`float<class_float>`\ )
  407. - :ref:`float<class_float>` **get_mass**\ (\ )
  408. The body's mass.
  409. .. rst-class:: classref-item-separator
  410. ----
  411. .. _class_RigidBody3D_property_max_contacts_reported:
  412. .. rst-class:: classref-property
  413. :ref:`int<class_int>` **max_contacts_reported** = ``0`` :ref:`🔗<class_RigidBody3D_property_max_contacts_reported>`
  414. .. rst-class:: classref-property-setget
  415. - |void| **set_max_contacts_reported**\ (\ value\: :ref:`int<class_int>`\ )
  416. - :ref:`int<class_int>` **get_max_contacts_reported**\ (\ )
  417. The maximum number of contacts that will be recorded. Requires a value greater than 0 and :ref:`contact_monitor<class_RigidBody3D_property_contact_monitor>` to be set to ``true`` to start to register contacts. Use :ref:`get_contact_count<class_RigidBody3D_method_get_contact_count>` to retrieve the count or :ref:`get_colliding_bodies<class_RigidBody3D_method_get_colliding_bodies>` to retrieve bodies that have been collided with.
  418. \ **Note:** The number of contacts is different from the number of collisions. Collisions between parallel edges will result in two contacts (one at each end), and collisions between parallel faces will result in four contacts (one at each corner).
  419. .. rst-class:: classref-item-separator
  420. ----
  421. .. _class_RigidBody3D_property_physics_material_override:
  422. .. rst-class:: classref-property
  423. :ref:`PhysicsMaterial<class_PhysicsMaterial>` **physics_material_override** :ref:`🔗<class_RigidBody3D_property_physics_material_override>`
  424. .. rst-class:: classref-property-setget
  425. - |void| **set_physics_material_override**\ (\ value\: :ref:`PhysicsMaterial<class_PhysicsMaterial>`\ )
  426. - :ref:`PhysicsMaterial<class_PhysicsMaterial>` **get_physics_material_override**\ (\ )
  427. The physics material override for the body.
  428. If a material is assigned to this property, it will be used instead of any other physics material, such as an inherited one.
  429. .. rst-class:: classref-item-separator
  430. ----
  431. .. _class_RigidBody3D_property_sleeping:
  432. .. rst-class:: classref-property
  433. :ref:`bool<class_bool>` **sleeping** = ``false`` :ref:`🔗<class_RigidBody3D_property_sleeping>`
  434. .. rst-class:: classref-property-setget
  435. - |void| **set_sleeping**\ (\ value\: :ref:`bool<class_bool>`\ )
  436. - :ref:`bool<class_bool>` **is_sleeping**\ (\ )
  437. If ``true``, the body will not move and will not calculate forces until woken up by another body through, for example, a collision, or by using the :ref:`apply_impulse<class_RigidBody3D_method_apply_impulse>` or :ref:`apply_force<class_RigidBody3D_method_apply_force>` methods.
  438. .. rst-class:: classref-section-separator
  439. ----
  440. .. rst-class:: classref-descriptions-group
  441. Method Descriptions
  442. -------------------
  443. .. _class_RigidBody3D_private_method__integrate_forces:
  444. .. rst-class:: classref-method
  445. |void| **_integrate_forces**\ (\ state\: :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>`\ ) |virtual| :ref:`🔗<class_RigidBody3D_private_method__integrate_forces>`
  446. 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_RigidBody3D_property_custom_integrator>` property allows you to disable the standard force integration and do fully custom force integration for a body.
  447. .. rst-class:: classref-item-separator
  448. ----
  449. .. _class_RigidBody3D_method_add_constant_central_force:
  450. .. rst-class:: classref-method
  451. |void| **add_constant_central_force**\ (\ force\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_RigidBody3D_method_add_constant_central_force>`
  452. Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with ``constant_force = Vector3(0, 0, 0)``.
  453. This is equivalent to using :ref:`add_constant_force<class_RigidBody3D_method_add_constant_force>` at the body's center of mass.
  454. .. rst-class:: classref-item-separator
  455. ----
  456. .. _class_RigidBody3D_method_add_constant_force:
  457. .. rst-class:: classref-method
  458. |void| **add_constant_force**\ (\ force\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) :ref:`🔗<class_RigidBody3D_method_add_constant_force>`
  459. Adds a constant positioned force to the body that keeps being applied over time until cleared with ``constant_force = Vector3(0, 0, 0)``.
  460. \ ``position`` is the offset from the body origin in global coordinates.
  461. .. rst-class:: classref-item-separator
  462. ----
  463. .. _class_RigidBody3D_method_add_constant_torque:
  464. .. rst-class:: classref-method
  465. |void| **add_constant_torque**\ (\ torque\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_RigidBody3D_method_add_constant_torque>`
  466. Adds a constant rotational force without affecting position that keeps being applied over time until cleared with ``constant_torque = Vector3(0, 0, 0)``.
  467. .. rst-class:: classref-item-separator
  468. ----
  469. .. _class_RigidBody3D_method_apply_central_force:
  470. .. rst-class:: classref-method
  471. |void| **apply_central_force**\ (\ force\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_RigidBody3D_method_apply_central_force>`
  472. Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update.
  473. This is equivalent to using :ref:`apply_force<class_RigidBody3D_method_apply_force>` at the body's center of mass.
  474. .. rst-class:: classref-item-separator
  475. ----
  476. .. _class_RigidBody3D_method_apply_central_impulse:
  477. .. rst-class:: classref-method
  478. |void| **apply_central_impulse**\ (\ impulse\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_RigidBody3D_method_apply_central_impulse>`
  479. Applies a directional impulse without affecting rotation.
  480. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
  481. This is equivalent to using :ref:`apply_impulse<class_RigidBody3D_method_apply_impulse>` at the body's center of mass.
  482. .. rst-class:: classref-item-separator
  483. ----
  484. .. _class_RigidBody3D_method_apply_force:
  485. .. rst-class:: classref-method
  486. |void| **apply_force**\ (\ force\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) :ref:`🔗<class_RigidBody3D_method_apply_force>`
  487. Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update.
  488. \ ``position`` is the offset from the body origin in global coordinates.
  489. .. rst-class:: classref-item-separator
  490. ----
  491. .. _class_RigidBody3D_method_apply_impulse:
  492. .. rst-class:: classref-method
  493. |void| **apply_impulse**\ (\ impulse\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) :ref:`🔗<class_RigidBody3D_method_apply_impulse>`
  494. Applies a positioned impulse to the body.
  495. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
  496. \ ``position`` is the offset from the body origin in global coordinates.
  497. .. rst-class:: classref-item-separator
  498. ----
  499. .. _class_RigidBody3D_method_apply_torque:
  500. .. rst-class:: classref-method
  501. |void| **apply_torque**\ (\ torque\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_RigidBody3D_method_apply_torque>`
  502. Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update.
  503. \ **Note:** :ref:`inertia<class_RigidBody3D_property_inertia>` is required for this to work. To have :ref:`inertia<class_RigidBody3D_property_inertia>`, an active :ref:`CollisionShape3D<class_CollisionShape3D>` must be a child of the node, or you can manually set :ref:`inertia<class_RigidBody3D_property_inertia>`.
  504. .. rst-class:: classref-item-separator
  505. ----
  506. .. _class_RigidBody3D_method_apply_torque_impulse:
  507. .. rst-class:: classref-method
  508. |void| **apply_torque_impulse**\ (\ impulse\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_RigidBody3D_method_apply_torque_impulse>`
  509. Applies a rotational impulse to the body without affecting the position.
  510. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
  511. \ **Note:** :ref:`inertia<class_RigidBody3D_property_inertia>` is required for this to work. To have :ref:`inertia<class_RigidBody3D_property_inertia>`, an active :ref:`CollisionShape3D<class_CollisionShape3D>` must be a child of the node, or you can manually set :ref:`inertia<class_RigidBody3D_property_inertia>`.
  512. .. rst-class:: classref-item-separator
  513. ----
  514. .. _class_RigidBody3D_method_get_colliding_bodies:
  515. .. rst-class:: classref-method
  516. :ref:`Array<class_Array>`\[:ref:`Node3D<class_Node3D>`\] **get_colliding_bodies**\ (\ ) |const| :ref:`🔗<class_RigidBody3D_method_get_colliding_bodies>`
  517. Returns a list of the bodies colliding with this one. Requires :ref:`contact_monitor<class_RigidBody3D_property_contact_monitor>` to be set to ``true`` and :ref:`max_contacts_reported<class_RigidBody3D_property_max_contacts_reported>` to be set high enough to detect all the collisions.
  518. \ **Note:** The result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead.
  519. .. rst-class:: classref-item-separator
  520. ----
  521. .. _class_RigidBody3D_method_get_contact_count:
  522. .. rst-class:: classref-method
  523. :ref:`int<class_int>` **get_contact_count**\ (\ ) |const| :ref:`🔗<class_RigidBody3D_method_get_contact_count>`
  524. Returns the number of contacts this body has with other bodies. By default, this returns 0 unless bodies are configured to monitor contacts (see :ref:`contact_monitor<class_RigidBody3D_property_contact_monitor>`).
  525. \ **Note:** To retrieve the colliding bodies, use :ref:`get_colliding_bodies<class_RigidBody3D_method_get_colliding_bodies>`.
  526. .. rst-class:: classref-item-separator
  527. ----
  528. .. _class_RigidBody3D_method_get_inverse_inertia_tensor:
  529. .. rst-class:: classref-method
  530. :ref:`Basis<class_Basis>` **get_inverse_inertia_tensor**\ (\ ) |const| :ref:`🔗<class_RigidBody3D_method_get_inverse_inertia_tensor>`
  531. Returns the inverse inertia tensor basis. This is used to calculate the angular acceleration resulting from a torque applied to the **RigidBody3D**.
  532. .. rst-class:: classref-item-separator
  533. ----
  534. .. _class_RigidBody3D_method_set_axis_velocity:
  535. .. rst-class:: classref-method
  536. |void| **set_axis_velocity**\ (\ axis_velocity\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_RigidBody3D_method_set_axis_velocity>`
  537. Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.
  538. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  539. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  540. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  541. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  542. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  543. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  544. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  545. .. |void| replace:: :abbr:`void (No return value.)`