Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: b51a272459
Branches Tags
godot-docs
/
classes
/
class_physics2ddirectbodystate.rst

class_physics2ddirectbodystate.rst 19 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
    3. 

  3. 

  4. .. _class_Physics2DDirectBodyState:
    5. 

  5. 

  6. Physics2DDirectBodyState
    7. 

  7. ========================
    8. 

  8. 

  9. **Inherits:** :ref:`Object<class_object>`
    10. 

  10. 

  11. **Inherited By:** :ref:`Physics2DDirectBodyStateSW<class_physics2ddirectbodystatesw>`
    12. 

  12. 

  13. **Category:** Core
    14. 

  14. 

  15. Brief Description
    16. 

  16. -----------------
    17. 

  17. 

  18. Direct access object to a physics body in the :ref:`Physics2DServer<class_physics2dserver>`.
    19. 

  19. 

  20. Member Functions
    21. 

  21. ----------------
    22. 

  22. 

  23. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    24. 

  24. | :ref:`Vector2<class_vector2>`                                      | :ref:`get_total_gravity<class_Physics2DDirectBodyState_get_total_gravity>`  **(** **)** const                                                                          |
    25. 

  25. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    26. 

  26. | :ref:`float<class_float>`                                          | :ref:`get_total_linear_damp<class_Physics2DDirectBodyState_get_total_linear_damp>`  **(** **)** const                                                                  |
    27. 

  27. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    28. 

  28. | :ref:`float<class_float>`                                          | :ref:`get_total_angular_damp<class_Physics2DDirectBodyState_get_total_angular_damp>`  **(** **)** const                                                                |
    29. 

  29. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | :ref:`float<class_float>`                                          | :ref:`get_inverse_mass<class_Physics2DDirectBodyState_get_inverse_mass>`  **(** **)** const                                                                            |
    31. 

  31. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`float<class_float>`                                          | :ref:`get_inverse_inertia<class_Physics2DDirectBodyState_get_inverse_inertia>`  **(** **)** const                                                                      |
    33. 

  33. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | void                                                               | :ref:`set_linear_velocity<class_Physics2DDirectBodyState_set_linear_velocity>`  **(** :ref:`Vector2<class_vector2>` velocity  **)**                                    |
    35. 

  35. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | :ref:`Vector2<class_vector2>`                                      | :ref:`get_linear_velocity<class_Physics2DDirectBodyState_get_linear_velocity>`  **(** **)** const                                                                      |
    37. 

  37. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | void                                                               | :ref:`set_angular_velocity<class_Physics2DDirectBodyState_set_angular_velocity>`  **(** :ref:`float<class_float>` velocity  **)**                                      |
    39. 

  39. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | :ref:`float<class_float>`                                          | :ref:`get_angular_velocity<class_Physics2DDirectBodyState_get_angular_velocity>`  **(** **)** const                                                                    |
    41. 

  41. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | void                                                               | :ref:`set_transform<class_Physics2DDirectBodyState_set_transform>`  **(** :ref:`Matrix32<class_matrix32>` transform  **)**                                             |
    43. 

  43. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | :ref:`Matrix32<class_matrix32>`                                    | :ref:`get_transform<class_Physics2DDirectBodyState_get_transform>`  **(** **)** const                                                                                  |
    45. 

  45. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | void                                                               | :ref:`set_sleep_state<class_Physics2DDirectBodyState_set_sleep_state>`  **(** :ref:`bool<class_bool>` enabled  **)**                                                   |
    47. 

  47. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. | :ref:`bool<class_bool>`                                            | :ref:`is_sleeping<class_Physics2DDirectBodyState_is_sleeping>`  **(** **)** const                                                                                      |
    49. 

  49. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    50. 

  50. | :ref:`int<class_int>`                                              | :ref:`get_contact_count<class_Physics2DDirectBodyState_get_contact_count>`  **(** **)** const                                                                          |
    51. 

  51. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    52. 

  52. | :ref:`Vector2<class_vector2>`                                      | :ref:`get_contact_local_pos<class_Physics2DDirectBodyState_get_contact_local_pos>`  **(** :ref:`int<class_int>` contact_idx  **)** const                               |
    53. 

  53. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    54. 

  54. | :ref:`Vector2<class_vector2>`                                      | :ref:`get_contact_local_normal<class_Physics2DDirectBodyState_get_contact_local_normal>`  **(** :ref:`int<class_int>` contact_idx  **)** const                         |
    55. 

  55. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    56. 

  56. | :ref:`int<class_int>`                                              | :ref:`get_contact_local_shape<class_Physics2DDirectBodyState_get_contact_local_shape>`  **(** :ref:`int<class_int>` contact_idx  **)** const                           |
    57. 

  57. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    58. 

  58. | :ref:`RID<class_rid>`                                              | :ref:`get_contact_collider<class_Physics2DDirectBodyState_get_contact_collider>`  **(** :ref:`int<class_int>` contact_idx  **)** const                                 |
    59. 

  59. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    60. 

  60. | :ref:`Vector2<class_vector2>`                                      | :ref:`get_contact_collider_pos<class_Physics2DDirectBodyState_get_contact_collider_pos>`  **(** :ref:`int<class_int>` contact_idx  **)** const                         |
    61. 

  61. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    62. 

  62. | :ref:`int<class_int>`                                              | :ref:`get_contact_collider_id<class_Physics2DDirectBodyState_get_contact_collider_id>`  **(** :ref:`int<class_int>` contact_idx  **)** const                           |
    63. 

  63. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    64. 

  64. | :ref:`Object<class_object>`                                        | :ref:`get_contact_collider_object<class_Physics2DDirectBodyState_get_contact_collider_object>`  **(** :ref:`int<class_int>` contact_idx  **)** const                   |
    65. 

  65. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    66. 

  66. | :ref:`int<class_int>`                                              | :ref:`get_contact_collider_shape<class_Physics2DDirectBodyState_get_contact_collider_shape>`  **(** :ref:`int<class_int>` contact_idx  **)** const                     |
    67. 

  67. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    68. 

  68. | Variant                                                            | :ref:`get_contact_collider_shape_metadata<class_Physics2DDirectBodyState_get_contact_collider_shape_metadata>`  **(** :ref:`int<class_int>` contact_idx  **)** const   |
    69. 

  69. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    70. 

  70. | :ref:`Vector2<class_vector2>`                                      | :ref:`get_contact_collider_velocity_at_pos<class_Physics2DDirectBodyState_get_contact_collider_velocity_at_pos>`  **(** :ref:`int<class_int>` contact_idx  **)** const |
    71. 

  71. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    72. 

  72. | :ref:`float<class_float>`                                          | :ref:`get_step<class_Physics2DDirectBodyState_get_step>`  **(** **)** const                                                                                            |
    73. 

  73. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    74. 

  74. | void                                                               | :ref:`integrate_forces<class_Physics2DDirectBodyState_integrate_forces>`  **(** **)**                                                                                  |
    75. 

  75. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    76. 

  76. | :ref:`Physics2DDirectSpaceState<class_physics2ddirectspacestate>`  | :ref:`get_space_state<class_Physics2DDirectBodyState_get_space_state>`  **(** **)**                                                                                    |
    77. 

  77. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    78. 

  78. 

  79. Description
    80. 

  80. -----------
    81. 

  81. 

  82. Direct access object to a physics body in the :ref:`Physics2DServer<class_physics2dserver>`. This object is passed via the direct state callback of rigid/character bodies, and is intended for changing the direct state of that body.
    83. 

  83. 

  84. Member Function Description
    85. 

  85. ---------------------------
    86. 

  86. 

  87. .. _class_Physics2DDirectBodyState_get_total_gravity:
    88. 

  88. 

  89. - :ref:`Vector2<class_vector2>`  **get_total_gravity**  **(** **)** const
    90. 

  90. 

  91. Return the total gravity vector being currently applied to this body.
    92. 

  92. 

  93. .. _class_Physics2DDirectBodyState_get_total_linear_damp:
    94. 

  94. 

  95. - :ref:`float<class_float>`  **get_total_linear_damp**  **(** **)** const
    96. 

  96. 

  97. .. _class_Physics2DDirectBodyState_get_total_angular_damp:
    98. 

  98. 

  99. - :ref:`float<class_float>`  **get_total_angular_damp**  **(** **)** const
    100. 

  100. 

  101. .. _class_Physics2DDirectBodyState_get_inverse_mass:
    102. 

  102. 

  103. - :ref:`float<class_float>`  **get_inverse_mass**  **(** **)** const
    104. 

  104. 

  105. Return the inverse of the mass of the body.
    106. 

  106. 

  107. .. _class_Physics2DDirectBodyState_get_inverse_inertia:
    108. 

  108. 

  109. - :ref:`float<class_float>`  **get_inverse_inertia**  **(** **)** const
    110. 

  110. 

  111. Return the inverse of the inertia of the body.
    112. 

  112. 

  113. .. _class_Physics2DDirectBodyState_set_linear_velocity:
    114. 

  114. 

  115. - void  **set_linear_velocity**  **(** :ref:`Vector2<class_vector2>` velocity  **)**
    116. 

  116. 

  117. Change the linear velocity of the body.
    118. 

  118. 

  119. .. _class_Physics2DDirectBodyState_get_linear_velocity:
    120. 

  120. 

  121. - :ref:`Vector2<class_vector2>`  **get_linear_velocity**  **(** **)** const
    122. 

  122. 

  123. Return the current linear velocity of the body.
    124. 

  124. 

  125. .. _class_Physics2DDirectBodyState_set_angular_velocity:
    126. 

  126. 

  127. - void  **set_angular_velocity**  **(** :ref:`float<class_float>` velocity  **)**
    128. 

  128. 

  129. Change the angular velocity of the body.
    130. 

  130. 

  131. .. _class_Physics2DDirectBodyState_get_angular_velocity:
    132. 

  132. 

  133. - :ref:`float<class_float>`  **get_angular_velocity**  **(** **)** const
    134. 

  134. 

  135. Return the angular velocity of the body.
    136. 

  136. 

  137. .. _class_Physics2DDirectBodyState_set_transform:
    138. 

  138. 

  139. - void  **set_transform**  **(** :ref:`Matrix32<class_matrix32>` transform  **)**
    140. 

  140. 

  141. Change the transform matrix of the body.
    142. 

  142. 

  143. .. _class_Physics2DDirectBodyState_get_transform:
    144. 

  144. 

  145. - :ref:`Matrix32<class_matrix32>`  **get_transform**  **(** **)** const
    146. 

  146. 

  147. Return the transform matrix of the body.
    148. 

  148. 

  149. .. _class_Physics2DDirectBodyState_set_sleep_state:
    150. 

  150. 

  151. - void  **set_sleep_state**  **(** :ref:`bool<class_bool>` enabled  **)**
    152. 

  152. 

  153. Set the sleeping state of the body, only affects character/rigid bodies.
    154. 

  154. 

  155. .. _class_Physics2DDirectBodyState_is_sleeping:
    156. 

  156. 

  157. - :ref:`bool<class_bool>`  **is_sleeping**  **(** **)** const
    158. 

  158. 

  159. Return true if this body is currently sleeping (not active).
    160. 

  160. 

  161. .. _class_Physics2DDirectBodyState_get_contact_count:
    162. 

  162. 

  163. - :ref:`int<class_int>`  **get_contact_count**  **(** **)** const
    164. 

  164. 

  165. Return the amount of contacts this body has with other bodies. Note that by default this returns 0 unless bodies are configured to log contacts.
    166. 

  166. 

  167. .. _class_Physics2DDirectBodyState_get_contact_local_pos:
    168. 

  168. 

  169. - :ref:`Vector2<class_vector2>`  **get_contact_local_pos**  **(** :ref:`int<class_int>` contact_idx  **)** const
    170. 

  170. 

  171. Return the local position (of this body) of the contact point.
    172. 

  172. 

  173. .. _class_Physics2DDirectBodyState_get_contact_local_normal:
    174. 

  174. 

  175. - :ref:`Vector2<class_vector2>`  **get_contact_local_normal**  **(** :ref:`int<class_int>` contact_idx  **)** const
    176. 

  176. 

  177. .. _class_Physics2DDirectBodyState_get_contact_local_shape:
    178. 

  178. 

  179. - :ref:`int<class_int>`  **get_contact_local_shape**  **(** :ref:`int<class_int>` contact_idx  **)** const
    180. 

  180. 

  181. Return the local shape index of the collision.
    182. 

  182. 

  183. .. _class_Physics2DDirectBodyState_get_contact_collider:
    184. 

  184. 

  185. - :ref:`RID<class_rid>`  **get_contact_collider**  **(** :ref:`int<class_int>` contact_idx  **)** const
    186. 

  186. 

  187. Return the RID of the collider.
    188. 

  188. 

  189. .. _class_Physics2DDirectBodyState_get_contact_collider_pos:
    190. 

  190. 

  191. - :ref:`Vector2<class_vector2>`  **get_contact_collider_pos**  **(** :ref:`int<class_int>` contact_idx  **)** const
    192. 

  192. 

  193. Return the contact position in the collider.
    194. 

  194. 

  195. .. _class_Physics2DDirectBodyState_get_contact_collider_id:
    196. 

  196. 

  197. - :ref:`int<class_int>`  **get_contact_collider_id**  **(** :ref:`int<class_int>` contact_idx  **)** const
    198. 

  198. 

  199. Return the object id of the collider.
    200. 

  200. 

  201. .. _class_Physics2DDirectBodyState_get_contact_collider_object:
    202. 

  202. 

  203. - :ref:`Object<class_object>`  **get_contact_collider_object**  **(** :ref:`int<class_int>` contact_idx  **)** const
    204. 

  204. 

  205. Return the collider object, this depends on how it was created (will return a scene node if such was used to create it).
    206. 

  206. 

  207. .. _class_Physics2DDirectBodyState_get_contact_collider_shape:
    208. 

  208. 

  209. - :ref:`int<class_int>`  **get_contact_collider_shape**  **(** :ref:`int<class_int>` contact_idx  **)** const
    210. 

  210. 

  211. Return the collider shape index.
    212. 

  212. 

  213. .. _class_Physics2DDirectBodyState_get_contact_collider_shape_metadata:
    214. 

  214. 

  215. - Variant  **get_contact_collider_shape_metadata**  **(** :ref:`int<class_int>` contact_idx  **)** const
    216. 

  216. 

  217. .. _class_Physics2DDirectBodyState_get_contact_collider_velocity_at_pos:
    218. 

  218. 

  219. - :ref:`Vector2<class_vector2>`  **get_contact_collider_velocity_at_pos**  **(** :ref:`int<class_int>` contact_idx  **)** const
    220. 

  220. 

  221. Return the linear velocity vector at contact point of the collider.
    222. 

  222. 

  223. .. _class_Physics2DDirectBodyState_get_step:
    224. 

  224. 

  225. - :ref:`float<class_float>`  **get_step**  **(** **)** const
    226. 

  226. 

  227. Return the timestep (delta) used for the simulation.
    228. 

  228. 

  229. .. _class_Physics2DDirectBodyState_integrate_forces:
    230. 

  230. 

  231. - void  **integrate_forces**  **(** **)**
    232. 

  232. 

  233. Call the built-in force integration code.
    234. 

  234. 

  235. .. _class_Physics2DDirectBodyState_get_space_state:
    236. 

  236. 

  237. - :ref:`Physics2DDirectSpaceState<class_physics2ddirectspacestate>`  **get_space_state**  **(** **)**
    238. 

  238. 

  239. Return the current state of space, useful for queries.
    240. 

  240. 

  241.