class_physics2dserver.rst 128 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the Physics2DServer.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_Physics2DServer:
  6. Physics2DServer
  7. ===============
  8. **Inherits:** :ref:`Object<class_Object>`
  9. **Inherited By:** :ref:`Physics2DServerSW<class_Physics2DServerSW>`
  10. Server interface for low-level 2D physics access.
  11. Description
  12. -----------
  13. Physics2DServer is the server responsible for all 2D physics. It can create many kinds of physics objects, but does not insert them on the node tree.
  14. Methods
  15. -------
  16. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | void | :ref:`area_add_shape<class_Physics2DServer_method_area_add_shape>` **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` shape, :ref:`Transform2D<class_Transform2D>` transform=Transform2D( 1, 0, 0, 1, 0, 0 ), :ref:`bool<class_bool>` disabled=false **)** |
  18. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | void | :ref:`area_attach_canvas_instance_id<class_Physics2DServer_method_area_attach_canvas_instance_id>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)** |
  20. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`area_attach_object_instance_id<class_Physics2DServer_method_area_attach_object_instance_id>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)** |
  22. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`area_clear_shapes<class_Physics2DServer_method_area_clear_shapes>` **(** :ref:`RID<class_RID>` area **)** |
  24. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`RID<class_RID>` | :ref:`area_create<class_Physics2DServer_method_area_create>` **(** **)** |
  26. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`int<class_int>` | :ref:`area_get_canvas_instance_id<class_Physics2DServer_method_area_get_canvas_instance_id>` **(** :ref:`RID<class_RID>` area **)** const |
  28. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`int<class_int>` | :ref:`area_get_object_instance_id<class_Physics2DServer_method_area_get_object_instance_id>` **(** :ref:`RID<class_RID>` area **)** const |
  30. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`Variant<class_Variant>` | :ref:`area_get_param<class_Physics2DServer_method_area_get_param>` **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` param **)** const |
  32. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`RID<class_RID>` | :ref:`area_get_shape<class_Physics2DServer_method_area_get_shape>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** const |
  34. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`int<class_int>` | :ref:`area_get_shape_count<class_Physics2DServer_method_area_get_shape_count>` **(** :ref:`RID<class_RID>` area **)** const |
  36. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | :ref:`Transform2D<class_Transform2D>` | :ref:`area_get_shape_transform<class_Physics2DServer_method_area_get_shape_transform>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** const |
  38. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | :ref:`RID<class_RID>` | :ref:`area_get_space<class_Physics2DServer_method_area_get_space>` **(** :ref:`RID<class_RID>` area **)** const |
  40. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`AreaSpaceOverrideMode<enum_Physics2DServer_AreaSpaceOverrideMode>` | :ref:`area_get_space_override_mode<class_Physics2DServer_method_area_get_space_override_mode>` **(** :ref:`RID<class_RID>` area **)** const |
  42. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | :ref:`Transform2D<class_Transform2D>` | :ref:`area_get_transform<class_Physics2DServer_method_area_get_transform>` **(** :ref:`RID<class_RID>` area **)** const |
  44. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | void | :ref:`area_remove_shape<class_Physics2DServer_method_area_remove_shape>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |
  46. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | void | :ref:`area_set_area_monitor_callback<class_Physics2DServer_method_area_set_area_monitor_callback>` **(** :ref:`RID<class_RID>` area, :ref:`Object<class_Object>` receiver, :ref:`StringName<class_StringName>` method **)** |
  48. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | void | :ref:`area_set_collision_layer<class_Physics2DServer_method_area_set_collision_layer>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` layer **)** |
  50. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | void | :ref:`area_set_collision_mask<class_Physics2DServer_method_area_set_collision_mask>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` mask **)** |
  52. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | void | :ref:`area_set_monitor_callback<class_Physics2DServer_method_area_set_monitor_callback>` **(** :ref:`RID<class_RID>` area, :ref:`Object<class_Object>` receiver, :ref:`StringName<class_StringName>` method **)** |
  54. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | void | :ref:`area_set_monitorable<class_Physics2DServer_method_area_set_monitorable>` **(** :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` monitorable **)** |
  56. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | void | :ref:`area_set_param<class_Physics2DServer_method_area_set_param>` **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` param, :ref:`Variant<class_Variant>` value **)** |
  58. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | void | :ref:`area_set_shape<class_Physics2DServer_method_area_set_shape>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)** |
  60. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | void | :ref:`area_set_shape_disabled<class_Physics2DServer_method_area_set_shape_disabled>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)** |
  62. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | void | :ref:`area_set_shape_transform<class_Physics2DServer_method_area_set_shape_transform>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_Transform2D>` transform **)** |
  64. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | void | :ref:`area_set_space<class_Physics2DServer_method_area_set_space>` **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` space **)** |
  66. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | void | :ref:`area_set_space_override_mode<class_Physics2DServer_method_area_set_space_override_mode>` **(** :ref:`RID<class_RID>` area, :ref:`AreaSpaceOverrideMode<enum_Physics2DServer_AreaSpaceOverrideMode>` mode **)** |
  68. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | void | :ref:`area_set_transform<class_Physics2DServer_method_area_set_transform>` **(** :ref:`RID<class_RID>` area, :ref:`Transform2D<class_Transform2D>` transform **)** |
  70. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | void | :ref:`body_add_central_force<class_Physics2DServer_method_body_add_central_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)** |
  72. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | void | :ref:`body_add_collision_exception<class_Physics2DServer_method_body_add_collision_exception>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)** |
  74. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | void | :ref:`body_add_force<class_Physics2DServer_method_body_add_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` offset, :ref:`Vector2<class_Vector2>` force **)** |
  76. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | void | :ref:`body_add_shape<class_Physics2DServer_method_body_add_shape>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` shape, :ref:`Transform2D<class_Transform2D>` transform=Transform2D( 1, 0, 0, 1, 0, 0 ), :ref:`bool<class_bool>` disabled=false **)** |
  78. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | void | :ref:`body_add_torque<class_Physics2DServer_method_body_add_torque>` **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)** |
  80. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | void | :ref:`body_apply_central_impulse<class_Physics2DServer_method_body_apply_central_impulse>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` impulse **)** |
  82. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | void | :ref:`body_apply_impulse<class_Physics2DServer_method_body_apply_impulse>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` position, :ref:`Vector2<class_Vector2>` impulse **)** |
  84. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | void | :ref:`body_apply_torque_impulse<class_Physics2DServer_method_body_apply_torque_impulse>` **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` impulse **)** |
  86. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | void | :ref:`body_attach_canvas_instance_id<class_Physics2DServer_method_body_attach_canvas_instance_id>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)** |
  88. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | void | :ref:`body_attach_object_instance_id<class_Physics2DServer_method_body_attach_object_instance_id>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)** |
  90. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | void | :ref:`body_clear_shapes<class_Physics2DServer_method_body_clear_shapes>` **(** :ref:`RID<class_RID>` body **)** |
  92. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | :ref:`RID<class_RID>` | :ref:`body_create<class_Physics2DServer_method_body_create>` **(** **)** |
  94. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | :ref:`int<class_int>` | :ref:`body_get_canvas_instance_id<class_Physics2DServer_method_body_get_canvas_instance_id>` **(** :ref:`RID<class_RID>` body **)** const |
  96. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | :ref:`int<class_int>` | :ref:`body_get_collision_layer<class_Physics2DServer_method_body_get_collision_layer>` **(** :ref:`RID<class_RID>` body **)** const |
  98. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | :ref:`int<class_int>` | :ref:`body_get_collision_mask<class_Physics2DServer_method_body_get_collision_mask>` **(** :ref:`RID<class_RID>` body **)** const |
  100. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | :ref:`CCDMode<enum_Physics2DServer_CCDMode>` | :ref:`body_get_continuous_collision_detection_mode<class_Physics2DServer_method_body_get_continuous_collision_detection_mode>` **(** :ref:`RID<class_RID>` body **)** const |
  102. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | :ref:`Physics2DDirectBodyState<class_Physics2DDirectBodyState>` | :ref:`body_get_direct_state<class_Physics2DServer_method_body_get_direct_state>` **(** :ref:`RID<class_RID>` body **)** |
  104. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | :ref:`int<class_int>` | :ref:`body_get_max_contacts_reported<class_Physics2DServer_method_body_get_max_contacts_reported>` **(** :ref:`RID<class_RID>` body **)** const |
  106. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | :ref:`BodyMode<enum_Physics2DServer_BodyMode>` | :ref:`body_get_mode<class_Physics2DServer_method_body_get_mode>` **(** :ref:`RID<class_RID>` body **)** const |
  108. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | :ref:`int<class_int>` | :ref:`body_get_object_instance_id<class_Physics2DServer_method_body_get_object_instance_id>` **(** :ref:`RID<class_RID>` body **)** const |
  110. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | :ref:`float<class_float>` | :ref:`body_get_param<class_Physics2DServer_method_body_get_param>` **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` param **)** const |
  112. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | :ref:`RID<class_RID>` | :ref:`body_get_shape<class_Physics2DServer_method_body_get_shape>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** const |
  114. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | :ref:`int<class_int>` | :ref:`body_get_shape_count<class_Physics2DServer_method_body_get_shape_count>` **(** :ref:`RID<class_RID>` body **)** const |
  116. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | :ref:`Variant<class_Variant>` | :ref:`body_get_shape_metadata<class_Physics2DServer_method_body_get_shape_metadata>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** const |
  118. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | :ref:`Transform2D<class_Transform2D>` | :ref:`body_get_shape_transform<class_Physics2DServer_method_body_get_shape_transform>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** const |
  120. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | :ref:`RID<class_RID>` | :ref:`body_get_space<class_Physics2DServer_method_body_get_space>` **(** :ref:`RID<class_RID>` body **)** const |
  122. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | :ref:`Variant<class_Variant>` | :ref:`body_get_state<class_Physics2DServer_method_body_get_state>` **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_Physics2DServer_BodyState>` state **)** const |
  124. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | :ref:`bool<class_bool>` | :ref:`body_is_omitting_force_integration<class_Physics2DServer_method_body_is_omitting_force_integration>` **(** :ref:`RID<class_RID>` body **)** const |
  126. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | void | :ref:`body_remove_collision_exception<class_Physics2DServer_method_body_remove_collision_exception>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)** |
  128. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | void | :ref:`body_remove_shape<class_Physics2DServer_method_body_remove_shape>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |
  130. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | void | :ref:`body_set_axis_velocity<class_Physics2DServer_method_body_set_axis_velocity>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` axis_velocity **)** |
  132. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | void | :ref:`body_set_collision_layer<class_Physics2DServer_method_body_set_collision_layer>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` layer **)** |
  134. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | void | :ref:`body_set_collision_mask<class_Physics2DServer_method_body_set_collision_mask>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` mask **)** |
  136. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | void | :ref:`body_set_continuous_collision_detection_mode<class_Physics2DServer_method_body_set_continuous_collision_detection_mode>` **(** :ref:`RID<class_RID>` body, :ref:`CCDMode<enum_Physics2DServer_CCDMode>` mode **)** |
  138. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | void | :ref:`body_set_force_integration_callback<class_Physics2DServer_method_body_set_force_integration_callback>` **(** :ref:`RID<class_RID>` body, :ref:`Object<class_Object>` receiver, :ref:`StringName<class_StringName>` method, :ref:`Variant<class_Variant>` userdata=null **)** |
  140. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | void | :ref:`body_set_max_contacts_reported<class_Physics2DServer_method_body_set_max_contacts_reported>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` amount **)** |
  142. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | void | :ref:`body_set_mode<class_Physics2DServer_method_body_set_mode>` **(** :ref:`RID<class_RID>` body, :ref:`BodyMode<enum_Physics2DServer_BodyMode>` mode **)** |
  144. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | void | :ref:`body_set_omit_force_integration<class_Physics2DServer_method_body_set_omit_force_integration>` **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)** |
  146. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | void | :ref:`body_set_param<class_Physics2DServer_method_body_set_param>` **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` param, :ref:`float<class_float>` value **)** |
  148. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | void | :ref:`body_set_shape<class_Physics2DServer_method_body_set_shape>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)** |
  150. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | void | :ref:`body_set_shape_as_one_way_collision<class_Physics2DServer_method_body_set_shape_as_one_way_collision>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` margin **)** |
  152. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | void | :ref:`body_set_shape_disabled<class_Physics2DServer_method_body_set_shape_disabled>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)** |
  154. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | void | :ref:`body_set_shape_metadata<class_Physics2DServer_method_body_set_shape_metadata>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`Variant<class_Variant>` metadata **)** |
  156. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | void | :ref:`body_set_shape_transform<class_Physics2DServer_method_body_set_shape_transform>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_Transform2D>` transform **)** |
  158. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | void | :ref:`body_set_space<class_Physics2DServer_method_body_set_space>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` space **)** |
  160. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | void | :ref:`body_set_state<class_Physics2DServer_method_body_set_state>` **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_Physics2DServer_BodyState>` state, :ref:`Variant<class_Variant>` value **)** |
  162. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | :ref:`bool<class_bool>` | :ref:`body_test_motion<class_Physics2DServer_method_body_test_motion>` **(** :ref:`RID<class_RID>` body, :ref:`Transform2D<class_Transform2D>` from, :ref:`Vector2<class_Vector2>` motion, :ref:`bool<class_bool>` infinite_inertia, :ref:`float<class_float>` margin=0.08, :ref:`Physics2DTestMotionResult<class_Physics2DTestMotionResult>` result=null **)** |
  164. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. | :ref:`RID<class_RID>` | :ref:`capsule_shape_create<class_Physics2DServer_method_capsule_shape_create>` **(** **)** |
  166. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  167. | :ref:`RID<class_RID>` | :ref:`circle_shape_create<class_Physics2DServer_method_circle_shape_create>` **(** **)** |
  168. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  169. | :ref:`RID<class_RID>` | :ref:`concave_polygon_shape_create<class_Physics2DServer_method_concave_polygon_shape_create>` **(** **)** |
  170. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  171. | :ref:`RID<class_RID>` | :ref:`convex_polygon_shape_create<class_Physics2DServer_method_convex_polygon_shape_create>` **(** **)** |
  172. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  173. | :ref:`RID<class_RID>` | :ref:`damped_spring_joint_create<class_Physics2DServer_method_damped_spring_joint_create>` **(** :ref:`Vector2<class_Vector2>` anchor_a, :ref:`Vector2<class_Vector2>` anchor_b, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)** |
  174. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  175. | :ref:`float<class_float>` | :ref:`damped_string_joint_get_param<class_Physics2DServer_method_damped_string_joint_get_param>` **(** :ref:`RID<class_RID>` joint, :ref:`DampedStringParam<enum_Physics2DServer_DampedStringParam>` param **)** const |
  176. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  177. | void | :ref:`damped_string_joint_set_param<class_Physics2DServer_method_damped_string_joint_set_param>` **(** :ref:`RID<class_RID>` joint, :ref:`DampedStringParam<enum_Physics2DServer_DampedStringParam>` param, :ref:`float<class_float>` value **)** |
  178. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  179. | void | :ref:`free_rid<class_Physics2DServer_method_free_rid>` **(** :ref:`RID<class_RID>` rid **)** |
  180. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  181. | :ref:`int<class_int>` | :ref:`get_process_info<class_Physics2DServer_method_get_process_info>` **(** :ref:`ProcessInfo<enum_Physics2DServer_ProcessInfo>` process_info **)** |
  182. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | :ref:`RID<class_RID>` | :ref:`groove_joint_create<class_Physics2DServer_method_groove_joint_create>` **(** :ref:`Vector2<class_Vector2>` groove1_a, :ref:`Vector2<class_Vector2>` groove2_a, :ref:`Vector2<class_Vector2>` anchor_b, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)** |
  184. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | :ref:`float<class_float>` | :ref:`joint_get_param<class_Physics2DServer_method_joint_get_param>` **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_Physics2DServer_JointParam>` param **)** const |
  186. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | :ref:`JointType<enum_Physics2DServer_JointType>` | :ref:`joint_get_type<class_Physics2DServer_method_joint_get_type>` **(** :ref:`RID<class_RID>` joint **)** const |
  188. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | void | :ref:`joint_set_param<class_Physics2DServer_method_joint_set_param>` **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_Physics2DServer_JointParam>` param, :ref:`float<class_float>` value **)** |
  190. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | :ref:`RID<class_RID>` | :ref:`line_shape_create<class_Physics2DServer_method_line_shape_create>` **(** **)** |
  192. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | :ref:`RID<class_RID>` | :ref:`pin_joint_create<class_Physics2DServer_method_pin_joint_create>` **(** :ref:`Vector2<class_Vector2>` anchor, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)** |
  194. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | :ref:`RID<class_RID>` | :ref:`ray_shape_create<class_Physics2DServer_method_ray_shape_create>` **(** **)** |
  196. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | :ref:`RID<class_RID>` | :ref:`rectangle_shape_create<class_Physics2DServer_method_rectangle_shape_create>` **(** **)** |
  198. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | :ref:`RID<class_RID>` | :ref:`segment_shape_create<class_Physics2DServer_method_segment_shape_create>` **(** **)** |
  200. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | void | :ref:`set_active<class_Physics2DServer_method_set_active>` **(** :ref:`bool<class_bool>` active **)** |
  202. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | :ref:`Variant<class_Variant>` | :ref:`shape_get_data<class_Physics2DServer_method_shape_get_data>` **(** :ref:`RID<class_RID>` shape **)** const |
  204. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | :ref:`ShapeType<enum_Physics2DServer_ShapeType>` | :ref:`shape_get_type<class_Physics2DServer_method_shape_get_type>` **(** :ref:`RID<class_RID>` shape **)** const |
  206. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | void | :ref:`shape_set_data<class_Physics2DServer_method_shape_set_data>` **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_Variant>` data **)** |
  208. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | :ref:`RID<class_RID>` | :ref:`space_create<class_Physics2DServer_method_space_create>` **(** **)** |
  210. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | :ref:`Physics2DDirectSpaceState<class_Physics2DDirectSpaceState>` | :ref:`space_get_direct_state<class_Physics2DServer_method_space_get_direct_state>` **(** :ref:`RID<class_RID>` space **)** |
  212. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. | :ref:`float<class_float>` | :ref:`space_get_param<class_Physics2DServer_method_space_get_param>` **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_Physics2DServer_SpaceParameter>` param **)** const |
  214. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  215. | :ref:`bool<class_bool>` | :ref:`space_is_active<class_Physics2DServer_method_space_is_active>` **(** :ref:`RID<class_RID>` space **)** const |
  216. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  217. | void | :ref:`space_set_active<class_Physics2DServer_method_space_set_active>` **(** :ref:`RID<class_RID>` space, :ref:`bool<class_bool>` active **)** |
  218. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  219. | void | :ref:`space_set_param<class_Physics2DServer_method_space_set_param>` **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_Physics2DServer_SpaceParameter>` param, :ref:`float<class_float>` value **)** |
  220. +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  221. Enumerations
  222. ------------
  223. .. _enum_Physics2DServer_SpaceParameter:
  224. .. _class_Physics2DServer_constant_SPACE_PARAM_CONTACT_RECYCLE_RADIUS:
  225. .. _class_Physics2DServer_constant_SPACE_PARAM_CONTACT_MAX_SEPARATION:
  226. .. _class_Physics2DServer_constant_SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION:
  227. .. _class_Physics2DServer_constant_SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD:
  228. .. _class_Physics2DServer_constant_SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD:
  229. .. _class_Physics2DServer_constant_SPACE_PARAM_BODY_TIME_TO_SLEEP:
  230. .. _class_Physics2DServer_constant_SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS:
  231. .. _class_Physics2DServer_constant_SPACE_PARAM_TEST_MOTION_MIN_CONTACT_DEPTH:
  232. enum **SpaceParameter**:
  233. - **SPACE_PARAM_CONTACT_RECYCLE_RADIUS** = **0** --- Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated.
  234. - **SPACE_PARAM_CONTACT_MAX_SEPARATION** = **1** --- Constant to set/get the maximum distance a shape can be from another before they are considered separated.
  235. - **SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION** = **2** --- Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision.
  236. - **SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD** = **3** --- Constant to set/get the threshold linear velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given.
  237. - **SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD** = **4** --- Constant to set/get the threshold angular velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given.
  238. - **SPACE_PARAM_BODY_TIME_TO_SLEEP** = **5** --- Constant to set/get the maximum time of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after this time.
  239. - **SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS** = **6** --- Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision.
  240. - **SPACE_PARAM_TEST_MOTION_MIN_CONTACT_DEPTH** = **7**
  241. ----
  242. .. _enum_Physics2DServer_ShapeType:
  243. .. _class_Physics2DServer_constant_SHAPE_LINE:
  244. .. _class_Physics2DServer_constant_SHAPE_RAY:
  245. .. _class_Physics2DServer_constant_SHAPE_SEGMENT:
  246. .. _class_Physics2DServer_constant_SHAPE_CIRCLE:
  247. .. _class_Physics2DServer_constant_SHAPE_RECTANGLE:
  248. .. _class_Physics2DServer_constant_SHAPE_CAPSULE:
  249. .. _class_Physics2DServer_constant_SHAPE_CONVEX_POLYGON:
  250. .. _class_Physics2DServer_constant_SHAPE_CONCAVE_POLYGON:
  251. .. _class_Physics2DServer_constant_SHAPE_CUSTOM:
  252. enum **ShapeType**:
  253. - **SHAPE_LINE** = **0** --- This is the constant for creating line shapes. A line shape is an infinite line with an origin point, and a normal. Thus, it can be used for front/behind checks.
  254. - **SHAPE_RAY** = **1**
  255. - **SHAPE_SEGMENT** = **2** --- This is the constant for creating segment shapes. A segment shape is a line from a point A to a point B. It can be checked for intersections.
  256. - **SHAPE_CIRCLE** = **3** --- This is the constant for creating circle shapes. A circle shape only has a radius. It can be used for intersections and inside/outside checks.
  257. - **SHAPE_RECTANGLE** = **4** --- This is the constant for creating rectangle shapes. A rectangle shape is defined by a width and a height. It can be used for intersections and inside/outside checks.
  258. - **SHAPE_CAPSULE** = **5** --- This is the constant for creating capsule shapes. A capsule shape is defined by a radius and a length. It can be used for intersections and inside/outside checks.
  259. - **SHAPE_CONVEX_POLYGON** = **6** --- This is the constant for creating convex polygon shapes. A polygon is defined by a list of points. It can be used for intersections and inside/outside checks. Unlike the :ref:`CollisionPolygon2D.polygon<class_CollisionPolygon2D_property_polygon>` property, polygons modified with :ref:`shape_set_data<class_Physics2DServer_method_shape_set_data>` do not verify that the points supplied form is a convex polygon.
  260. - **SHAPE_CONCAVE_POLYGON** = **7** --- This is the constant for creating concave polygon shapes. A polygon is defined by a list of points. It can be used for intersections checks, but not for inside/outside checks.
  261. - **SHAPE_CUSTOM** = **8** --- This constant is used internally by the engine. Any attempt to create this kind of shape results in an error.
  262. ----
  263. .. _enum_Physics2DServer_AreaParameter:
  264. .. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY:
  265. .. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY_VECTOR:
  266. .. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY_IS_POINT:
  267. .. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY_DISTANCE_SCALE:
  268. .. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY_POINT_ATTENUATION:
  269. .. _class_Physics2DServer_constant_AREA_PARAM_LINEAR_DAMP:
  270. .. _class_Physics2DServer_constant_AREA_PARAM_ANGULAR_DAMP:
  271. .. _class_Physics2DServer_constant_AREA_PARAM_PRIORITY:
  272. enum **AreaParameter**:
  273. - **AREA_PARAM_GRAVITY** = **0** --- Constant to set/get gravity strength in an area.
  274. - **AREA_PARAM_GRAVITY_VECTOR** = **1** --- Constant to set/get gravity vector/center in an area.
  275. - **AREA_PARAM_GRAVITY_IS_POINT** = **2** --- Constant to set/get whether the gravity vector of an area is a direction, or a center point.
  276. - **AREA_PARAM_GRAVITY_DISTANCE_SCALE** = **3** --- Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance.
  277. - **AREA_PARAM_GRAVITY_POINT_ATTENUATION** = **4** --- This constant was used to set/get the falloff factor for point gravity. It has been superseded by :ref:`AREA_PARAM_GRAVITY_DISTANCE_SCALE<class_Physics2DServer_constant_AREA_PARAM_GRAVITY_DISTANCE_SCALE>`.
  278. - **AREA_PARAM_LINEAR_DAMP** = **5** --- Constant to set/get the linear dampening factor of an area.
  279. - **AREA_PARAM_ANGULAR_DAMP** = **6** --- Constant to set/get the angular dampening factor of an area.
  280. - **AREA_PARAM_PRIORITY** = **7** --- Constant to set/get the priority (order of processing) of an area.
  281. ----
  282. .. _enum_Physics2DServer_AreaSpaceOverrideMode:
  283. .. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_DISABLED:
  284. .. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_COMBINE:
  285. .. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_COMBINE_REPLACE:
  286. .. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_REPLACE:
  287. .. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_REPLACE_COMBINE:
  288. enum **AreaSpaceOverrideMode**:
  289. - **AREA_SPACE_OVERRIDE_DISABLED** = **0** --- This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
  290. - **AREA_SPACE_OVERRIDE_COMBINE** = **1** --- This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects.
  291. - **AREA_SPACE_OVERRIDE_COMBINE_REPLACE** = **2** --- This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one.
  292. - **AREA_SPACE_OVERRIDE_REPLACE** = **3** --- This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
  293. - **AREA_SPACE_OVERRIDE_REPLACE_COMBINE** = **4** --- This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
  294. ----
  295. .. _enum_Physics2DServer_BodyMode:
  296. .. _class_Physics2DServer_constant_BODY_MODE_STATIC:
  297. .. _class_Physics2DServer_constant_BODY_MODE_KINEMATIC:
  298. .. _class_Physics2DServer_constant_BODY_MODE_RIGID:
  299. .. _class_Physics2DServer_constant_BODY_MODE_CHARACTER:
  300. enum **BodyMode**:
  301. - **BODY_MODE_STATIC** = **0** --- Constant for static bodies.
  302. - **BODY_MODE_KINEMATIC** = **1** --- Constant for kinematic bodies.
  303. - **BODY_MODE_RIGID** = **2** --- Constant for rigid bodies.
  304. - **BODY_MODE_CHARACTER** = **3** --- Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics.
  305. ----
  306. .. _enum_Physics2DServer_BodyParameter:
  307. .. _class_Physics2DServer_constant_BODY_PARAM_BOUNCE:
  308. .. _class_Physics2DServer_constant_BODY_PARAM_FRICTION:
  309. .. _class_Physics2DServer_constant_BODY_PARAM_MASS:
  310. .. _class_Physics2DServer_constant_BODY_PARAM_INERTIA:
  311. .. _class_Physics2DServer_constant_BODY_PARAM_GRAVITY_SCALE:
  312. .. _class_Physics2DServer_constant_BODY_PARAM_LINEAR_DAMP:
  313. .. _class_Physics2DServer_constant_BODY_PARAM_ANGULAR_DAMP:
  314. .. _class_Physics2DServer_constant_BODY_PARAM_MAX:
  315. enum **BodyParameter**:
  316. - **BODY_PARAM_BOUNCE** = **0** --- Constant to set/get a body's bounce factor.
  317. - **BODY_PARAM_FRICTION** = **1** --- Constant to set/get a body's friction.
  318. - **BODY_PARAM_MASS** = **2** --- Constant to set/get a body's mass.
  319. - **BODY_PARAM_INERTIA** = **3** --- Constant to set/get a body's inertia.
  320. - **BODY_PARAM_GRAVITY_SCALE** = **4** --- Constant to set/get a body's gravity multiplier.
  321. - **BODY_PARAM_LINEAR_DAMP** = **5** --- Constant to set/get a body's linear dampening factor.
  322. - **BODY_PARAM_ANGULAR_DAMP** = **6** --- Constant to set/get a body's angular dampening factor.
  323. - **BODY_PARAM_MAX** = **7** --- Represents the size of the :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` enum.
  324. ----
  325. .. _enum_Physics2DServer_BodyState:
  326. .. _class_Physics2DServer_constant_BODY_STATE_TRANSFORM:
  327. .. _class_Physics2DServer_constant_BODY_STATE_LINEAR_VELOCITY:
  328. .. _class_Physics2DServer_constant_BODY_STATE_ANGULAR_VELOCITY:
  329. .. _class_Physics2DServer_constant_BODY_STATE_SLEEPING:
  330. .. _class_Physics2DServer_constant_BODY_STATE_CAN_SLEEP:
  331. enum **BodyState**:
  332. - **BODY_STATE_TRANSFORM** = **0** --- Constant to set/get the current transform matrix of the body.
  333. - **BODY_STATE_LINEAR_VELOCITY** = **1** --- Constant to set/get the current linear velocity of the body.
  334. - **BODY_STATE_ANGULAR_VELOCITY** = **2** --- Constant to set/get the current angular velocity of the body.
  335. - **BODY_STATE_SLEEPING** = **3** --- Constant to sleep/wake up a body, or to get whether it is sleeping.
  336. - **BODY_STATE_CAN_SLEEP** = **4** --- Constant to set/get whether the body can sleep.
  337. ----
  338. .. _enum_Physics2DServer_JointType:
  339. .. _class_Physics2DServer_constant_JOINT_PIN:
  340. .. _class_Physics2DServer_constant_JOINT_GROOVE:
  341. .. _class_Physics2DServer_constant_JOINT_DAMPED_SPRING:
  342. enum **JointType**:
  343. - **JOINT_PIN** = **0** --- Constant to create pin joints.
  344. - **JOINT_GROOVE** = **1** --- Constant to create groove joints.
  345. - **JOINT_DAMPED_SPRING** = **2** --- Constant to create damped spring joints.
  346. ----
  347. .. _enum_Physics2DServer_JointParam:
  348. .. _class_Physics2DServer_constant_JOINT_PARAM_BIAS:
  349. .. _class_Physics2DServer_constant_JOINT_PARAM_MAX_BIAS:
  350. .. _class_Physics2DServer_constant_JOINT_PARAM_MAX_FORCE:
  351. enum **JointParam**:
  352. - **JOINT_PARAM_BIAS** = **0**
  353. - **JOINT_PARAM_MAX_BIAS** = **1**
  354. - **JOINT_PARAM_MAX_FORCE** = **2**
  355. ----
  356. .. _enum_Physics2DServer_DampedStringParam:
  357. .. _class_Physics2DServer_constant_DAMPED_STRING_REST_LENGTH:
  358. .. _class_Physics2DServer_constant_DAMPED_STRING_STIFFNESS:
  359. .. _class_Physics2DServer_constant_DAMPED_STRING_DAMPING:
  360. enum **DampedStringParam**:
  361. - **DAMPED_STRING_REST_LENGTH** = **0** --- Sets the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
  362. - **DAMPED_STRING_STIFFNESS** = **1** --- Sets the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
  363. - **DAMPED_STRING_DAMPING** = **2** --- Sets the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
  364. ----
  365. .. _enum_Physics2DServer_CCDMode:
  366. .. _class_Physics2DServer_constant_CCD_MODE_DISABLED:
  367. .. _class_Physics2DServer_constant_CCD_MODE_CAST_RAY:
  368. .. _class_Physics2DServer_constant_CCD_MODE_CAST_SHAPE:
  369. enum **CCDMode**:
  370. - **CCD_MODE_DISABLED** = **0** --- Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects.
  371. - **CCD_MODE_CAST_RAY** = **1** --- Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise.
  372. - **CCD_MODE_CAST_SHAPE** = **2** --- Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise.
  373. ----
  374. .. _enum_Physics2DServer_AreaBodyStatus:
  375. .. _class_Physics2DServer_constant_AREA_BODY_ADDED:
  376. .. _class_Physics2DServer_constant_AREA_BODY_REMOVED:
  377. enum **AreaBodyStatus**:
  378. - **AREA_BODY_ADDED** = **0** --- The value of the first parameter and area callback function receives, when an object enters one of its shapes.
  379. - **AREA_BODY_REMOVED** = **1** --- The value of the first parameter and area callback function receives, when an object exits one of its shapes.
  380. ----
  381. .. _enum_Physics2DServer_ProcessInfo:
  382. .. _class_Physics2DServer_constant_INFO_ACTIVE_OBJECTS:
  383. .. _class_Physics2DServer_constant_INFO_COLLISION_PAIRS:
  384. .. _class_Physics2DServer_constant_INFO_ISLAND_COUNT:
  385. enum **ProcessInfo**:
  386. - **INFO_ACTIVE_OBJECTS** = **0** --- Constant to get the number of objects that are not sleeping.
  387. - **INFO_COLLISION_PAIRS** = **1** --- Constant to get the number of possible collisions.
  388. - **INFO_ISLAND_COUNT** = **2** --- Constant to get the number of space regions where a collision could occur.
  389. Method Descriptions
  390. -------------------
  391. .. _class_Physics2DServer_method_area_add_shape:
  392. - void **area_add_shape** **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` shape, :ref:`Transform2D<class_Transform2D>` transform=Transform2D( 1, 0, 0, 1, 0, 0 ), :ref:`bool<class_bool>` disabled=false **)**
  393. Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
  394. ----
  395. .. _class_Physics2DServer_method_area_attach_canvas_instance_id:
  396. - void **area_attach_canvas_instance_id** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)**
  397. ----
  398. .. _class_Physics2DServer_method_area_attach_object_instance_id:
  399. - void **area_attach_object_instance_id** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)**
  400. Assigns the area to a descendant of :ref:`Object<class_Object>`, so it can exist in the node tree.
  401. ----
  402. .. _class_Physics2DServer_method_area_clear_shapes:
  403. - void **area_clear_shapes** **(** :ref:`RID<class_RID>` area **)**
  404. Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later.
  405. ----
  406. .. _class_Physics2DServer_method_area_create:
  407. - :ref:`RID<class_RID>` **area_create** **(** **)**
  408. Creates an :ref:`Area2D<class_Area2D>`.
  409. ----
  410. .. _class_Physics2DServer_method_area_get_canvas_instance_id:
  411. - :ref:`int<class_int>` **area_get_canvas_instance_id** **(** :ref:`RID<class_RID>` area **)** const
  412. ----
  413. .. _class_Physics2DServer_method_area_get_object_instance_id:
  414. - :ref:`int<class_int>` **area_get_object_instance_id** **(** :ref:`RID<class_RID>` area **)** const
  415. Gets the instance ID of the object the area is assigned to.
  416. ----
  417. .. _class_Physics2DServer_method_area_get_param:
  418. - :ref:`Variant<class_Variant>` **area_get_param** **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` param **)** const
  419. Returns an area parameter value. See :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` for a list of available parameters.
  420. ----
  421. .. _class_Physics2DServer_method_area_get_shape:
  422. - :ref:`RID<class_RID>` **area_get_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** const
  423. Returns the :ref:`RID<class_RID>` of the nth shape of an area.
  424. ----
  425. .. _class_Physics2DServer_method_area_get_shape_count:
  426. - :ref:`int<class_int>` **area_get_shape_count** **(** :ref:`RID<class_RID>` area **)** const
  427. Returns the number of shapes assigned to an area.
  428. ----
  429. .. _class_Physics2DServer_method_area_get_shape_transform:
  430. - :ref:`Transform2D<class_Transform2D>` **area_get_shape_transform** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** const
  431. Returns the transform matrix of a shape within an area.
  432. ----
  433. .. _class_Physics2DServer_method_area_get_space:
  434. - :ref:`RID<class_RID>` **area_get_space** **(** :ref:`RID<class_RID>` area **)** const
  435. Returns the space assigned to the area.
  436. ----
  437. .. _class_Physics2DServer_method_area_get_space_override_mode:
  438. - :ref:`AreaSpaceOverrideMode<enum_Physics2DServer_AreaSpaceOverrideMode>` **area_get_space_override_mode** **(** :ref:`RID<class_RID>` area **)** const
  439. Returns the space override mode for the area.
  440. ----
  441. .. _class_Physics2DServer_method_area_get_transform:
  442. - :ref:`Transform2D<class_Transform2D>` **area_get_transform** **(** :ref:`RID<class_RID>` area **)** const
  443. Returns the transform matrix for an area.
  444. ----
  445. .. _class_Physics2DServer_method_area_remove_shape:
  446. - void **area_remove_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)**
  447. Removes a shape from an area. It does not delete the shape, so it can be reassigned later.
  448. ----
  449. .. _class_Physics2DServer_method_area_set_area_monitor_callback:
  450. - void **area_set_area_monitor_callback** **(** :ref:`RID<class_RID>` area, :ref:`Object<class_Object>` receiver, :ref:`StringName<class_StringName>` method **)**
  451. ----
  452. .. _class_Physics2DServer_method_area_set_collision_layer:
  453. - void **area_set_collision_layer** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` layer **)**
  454. Assigns the area to one or many physics layers.
  455. ----
  456. .. _class_Physics2DServer_method_area_set_collision_mask:
  457. - void **area_set_collision_mask** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` mask **)**
  458. Sets which physics layers the area will monitor.
  459. ----
  460. .. _class_Physics2DServer_method_area_set_monitor_callback:
  461. - void **area_set_monitor_callback** **(** :ref:`RID<class_RID>` area, :ref:`Object<class_Object>` receiver, :ref:`StringName<class_StringName>` method **)**
  462. Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters:
  463. 1: :ref:`AREA_BODY_ADDED<class_Physics2DServer_constant_AREA_BODY_ADDED>` or :ref:`AREA_BODY_REMOVED<class_Physics2DServer_constant_AREA_BODY_REMOVED>`, depending on whether the object entered or exited the area.
  464. 2: :ref:`RID<class_RID>` of the object that entered/exited the area.
  465. 3: Instance ID of the object that entered/exited the area.
  466. 4: The shape index of the object that entered/exited the area.
  467. 5: The shape index of the area where the object entered/exited.
  468. ----
  469. .. _class_Physics2DServer_method_area_set_monitorable:
  470. - void **area_set_monitorable** **(** :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` monitorable **)**
  471. ----
  472. .. _class_Physics2DServer_method_area_set_param:
  473. - void **area_set_param** **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` param, :ref:`Variant<class_Variant>` value **)**
  474. Sets the value for an area parameter. See :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` for a list of available parameters.
  475. ----
  476. .. _class_Physics2DServer_method_area_set_shape:
  477. - void **area_set_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)**
  478. Substitutes a given area shape by another. The old shape is selected by its index, the new one by its :ref:`RID<class_RID>`.
  479. ----
  480. .. _class_Physics2DServer_method_area_set_shape_disabled:
  481. - void **area_set_shape_disabled** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)**
  482. Disables a given shape in an area.
  483. ----
  484. .. _class_Physics2DServer_method_area_set_shape_transform:
  485. - void **area_set_shape_transform** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_Transform2D>` transform **)**
  486. Sets the transform matrix for an area shape.
  487. ----
  488. .. _class_Physics2DServer_method_area_set_space:
  489. - void **area_set_space** **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` space **)**
  490. Assigns a space to the area.
  491. ----
  492. .. _class_Physics2DServer_method_area_set_space_override_mode:
  493. - void **area_set_space_override_mode** **(** :ref:`RID<class_RID>` area, :ref:`AreaSpaceOverrideMode<enum_Physics2DServer_AreaSpaceOverrideMode>` mode **)**
  494. Sets the space override mode for the area. See :ref:`AreaSpaceOverrideMode<enum_Physics2DServer_AreaSpaceOverrideMode>` for a list of available modes.
  495. ----
  496. .. _class_Physics2DServer_method_area_set_transform:
  497. - void **area_set_transform** **(** :ref:`RID<class_RID>` area, :ref:`Transform2D<class_Transform2D>` transform **)**
  498. Sets the transform matrix for an area.
  499. ----
  500. .. _class_Physics2DServer_method_body_add_central_force:
  501. - void **body_add_central_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)**
  502. ----
  503. .. _class_Physics2DServer_method_body_add_collision_exception:
  504. - void **body_add_collision_exception** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)**
  505. Adds a body to the list of bodies exempt from collisions.
  506. ----
  507. .. _class_Physics2DServer_method_body_add_force:
  508. - void **body_add_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` offset, :ref:`Vector2<class_Vector2>` force **)**
  509. Adds a positioned force to the applied force and torque. As with :ref:`body_apply_impulse<class_Physics2DServer_method_body_apply_impulse>`, both the force and the offset from the body origin are in global coordinates. A force differs from an impulse in that, while the two are forces, the impulse clears itself after being applied.
  510. ----
  511. .. _class_Physics2DServer_method_body_add_shape:
  512. - void **body_add_shape** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` shape, :ref:`Transform2D<class_Transform2D>` transform=Transform2D( 1, 0, 0, 1, 0, 0 ), :ref:`bool<class_bool>` disabled=false **)**
  513. Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
  514. ----
  515. .. _class_Physics2DServer_method_body_add_torque:
  516. - void **body_add_torque** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)**
  517. ----
  518. .. _class_Physics2DServer_method_body_apply_central_impulse:
  519. - void **body_apply_central_impulse** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` impulse **)**
  520. ----
  521. .. _class_Physics2DServer_method_body_apply_impulse:
  522. - void **body_apply_impulse** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` position, :ref:`Vector2<class_Vector2>` impulse **)**
  523. Adds a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates.
  524. ----
  525. .. _class_Physics2DServer_method_body_apply_torque_impulse:
  526. - void **body_apply_torque_impulse** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` impulse **)**
  527. ----
  528. .. _class_Physics2DServer_method_body_attach_canvas_instance_id:
  529. - void **body_attach_canvas_instance_id** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)**
  530. ----
  531. .. _class_Physics2DServer_method_body_attach_object_instance_id:
  532. - void **body_attach_object_instance_id** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)**
  533. Assigns the area to a descendant of :ref:`Object<class_Object>`, so it can exist in the node tree.
  534. ----
  535. .. _class_Physics2DServer_method_body_clear_shapes:
  536. - void **body_clear_shapes** **(** :ref:`RID<class_RID>` body **)**
  537. Removes all shapes from a body.
  538. ----
  539. .. _class_Physics2DServer_method_body_create:
  540. - :ref:`RID<class_RID>` **body_create** **(** **)**
  541. Creates a physics body.
  542. ----
  543. .. _class_Physics2DServer_method_body_get_canvas_instance_id:
  544. - :ref:`int<class_int>` **body_get_canvas_instance_id** **(** :ref:`RID<class_RID>` body **)** const
  545. ----
  546. .. _class_Physics2DServer_method_body_get_collision_layer:
  547. - :ref:`int<class_int>` **body_get_collision_layer** **(** :ref:`RID<class_RID>` body **)** const
  548. Returns the physics layer or layers a body belongs to.
  549. ----
  550. .. _class_Physics2DServer_method_body_get_collision_mask:
  551. - :ref:`int<class_int>` **body_get_collision_mask** **(** :ref:`RID<class_RID>` body **)** const
  552. Returns the physics layer or layers a body can collide with.
  553. ----
  554. .. _class_Physics2DServer_method_body_get_continuous_collision_detection_mode:
  555. - :ref:`CCDMode<enum_Physics2DServer_CCDMode>` **body_get_continuous_collision_detection_mode** **(** :ref:`RID<class_RID>` body **)** const
  556. Returns the continuous collision detection mode.
  557. ----
  558. .. _class_Physics2DServer_method_body_get_direct_state:
  559. - :ref:`Physics2DDirectBodyState<class_Physics2DDirectBodyState>` **body_get_direct_state** **(** :ref:`RID<class_RID>` body **)**
  560. Returns the :ref:`Physics2DDirectBodyState<class_Physics2DDirectBodyState>` of the body.
  561. ----
  562. .. _class_Physics2DServer_method_body_get_max_contacts_reported:
  563. - :ref:`int<class_int>` **body_get_max_contacts_reported** **(** :ref:`RID<class_RID>` body **)** const
  564. Returns the maximum contacts that can be reported. See :ref:`body_set_max_contacts_reported<class_Physics2DServer_method_body_set_max_contacts_reported>`.
  565. ----
  566. .. _class_Physics2DServer_method_body_get_mode:
  567. - :ref:`BodyMode<enum_Physics2DServer_BodyMode>` **body_get_mode** **(** :ref:`RID<class_RID>` body **)** const
  568. Returns the body mode.
  569. ----
  570. .. _class_Physics2DServer_method_body_get_object_instance_id:
  571. - :ref:`int<class_int>` **body_get_object_instance_id** **(** :ref:`RID<class_RID>` body **)** const
  572. Gets the instance ID of the object the area is assigned to.
  573. ----
  574. .. _class_Physics2DServer_method_body_get_param:
  575. - :ref:`float<class_float>` **body_get_param** **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` param **)** const
  576. Returns the value of a body parameter. See :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` for a list of available parameters.
  577. ----
  578. .. _class_Physics2DServer_method_body_get_shape:
  579. - :ref:`RID<class_RID>` **body_get_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** const
  580. Returns the :ref:`RID<class_RID>` of the nth shape of a body.
  581. ----
  582. .. _class_Physics2DServer_method_body_get_shape_count:
  583. - :ref:`int<class_int>` **body_get_shape_count** **(** :ref:`RID<class_RID>` body **)** const
  584. Returns the number of shapes assigned to a body.
  585. ----
  586. .. _class_Physics2DServer_method_body_get_shape_metadata:
  587. - :ref:`Variant<class_Variant>` **body_get_shape_metadata** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** const
  588. Returns the metadata of a shape of a body.
  589. ----
  590. .. _class_Physics2DServer_method_body_get_shape_transform:
  591. - :ref:`Transform2D<class_Transform2D>` **body_get_shape_transform** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** const
  592. Returns the transform matrix of a body shape.
  593. ----
  594. .. _class_Physics2DServer_method_body_get_space:
  595. - :ref:`RID<class_RID>` **body_get_space** **(** :ref:`RID<class_RID>` body **)** const
  596. Returns the :ref:`RID<class_RID>` of the space assigned to a body.
  597. ----
  598. .. _class_Physics2DServer_method_body_get_state:
  599. - :ref:`Variant<class_Variant>` **body_get_state** **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_Physics2DServer_BodyState>` state **)** const
  600. Returns a body state.
  601. ----
  602. .. _class_Physics2DServer_method_body_is_omitting_force_integration:
  603. - :ref:`bool<class_bool>` **body_is_omitting_force_integration** **(** :ref:`RID<class_RID>` body **)** const
  604. Returns whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback<class_Physics2DServer_method_body_set_force_integration_callback>`).
  605. ----
  606. .. _class_Physics2DServer_method_body_remove_collision_exception:
  607. - void **body_remove_collision_exception** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)**
  608. Removes a body from the list of bodies exempt from collisions.
  609. ----
  610. .. _class_Physics2DServer_method_body_remove_shape:
  611. - void **body_remove_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)**
  612. Removes a shape from a body. The shape is not deleted, so it can be reused afterwards.
  613. ----
  614. .. _class_Physics2DServer_method_body_set_axis_velocity:
  615. - void **body_set_axis_velocity** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` axis_velocity **)**
  616. 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.
  617. ----
  618. .. _class_Physics2DServer_method_body_set_collision_layer:
  619. - void **body_set_collision_layer** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` layer **)**
  620. Sets the physics layer or layers a body belongs to.
  621. ----
  622. .. _class_Physics2DServer_method_body_set_collision_mask:
  623. - void **body_set_collision_mask** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` mask **)**
  624. Sets the physics layer or layers a body can collide with.
  625. ----
  626. .. _class_Physics2DServer_method_body_set_continuous_collision_detection_mode:
  627. - void **body_set_continuous_collision_detection_mode** **(** :ref:`RID<class_RID>` body, :ref:`CCDMode<enum_Physics2DServer_CCDMode>` mode **)**
  628. Sets the continuous collision detection mode using one of the :ref:`CCDMode<enum_Physics2DServer_CCDMode>` constants.
  629. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
  630. ----
  631. .. _class_Physics2DServer_method_body_set_force_integration_callback:
  632. - void **body_set_force_integration_callback** **(** :ref:`RID<class_RID>` body, :ref:`Object<class_Object>` receiver, :ref:`StringName<class_StringName>` method, :ref:`Variant<class_Variant>` userdata=null **)**
  633. Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force_integration<class_Physics2DServer_method_body_set_omit_force_integration>`).
  634. ----
  635. .. _class_Physics2DServer_method_body_set_max_contacts_reported:
  636. - void **body_set_max_contacts_reported** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` amount **)**
  637. Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0.
  638. ----
  639. .. _class_Physics2DServer_method_body_set_mode:
  640. - void **body_set_mode** **(** :ref:`RID<class_RID>` body, :ref:`BodyMode<enum_Physics2DServer_BodyMode>` mode **)**
  641. Sets the body mode using one of the :ref:`BodyMode<enum_Physics2DServer_BodyMode>` constants.
  642. ----
  643. .. _class_Physics2DServer_method_body_set_omit_force_integration:
  644. - void **body_set_omit_force_integration** **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)**
  645. Sets whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback<class_Physics2DServer_method_body_set_force_integration_callback>`).
  646. ----
  647. .. _class_Physics2DServer_method_body_set_param:
  648. - void **body_set_param** **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` param, :ref:`float<class_float>` value **)**
  649. Sets a body parameter. See :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` for a list of available parameters.
  650. ----
  651. .. _class_Physics2DServer_method_body_set_shape:
  652. - void **body_set_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)**
  653. Substitutes a given body shape by another. The old shape is selected by its index, the new one by its :ref:`RID<class_RID>`.
  654. ----
  655. .. _class_Physics2DServer_method_body_set_shape_as_one_way_collision:
  656. - void **body_set_shape_as_one_way_collision** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` margin **)**
  657. Enables one way collision on body if ``enable`` is ``true``.
  658. ----
  659. .. _class_Physics2DServer_method_body_set_shape_disabled:
  660. - void **body_set_shape_disabled** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)**
  661. Disables shape in body if ``disable`` is ``true``.
  662. ----
  663. .. _class_Physics2DServer_method_body_set_shape_metadata:
  664. - void **body_set_shape_metadata** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`Variant<class_Variant>` metadata **)**
  665. Sets metadata of a shape within a body. This metadata is different from :ref:`Object.set_meta<class_Object_method_set_meta>`, and can be retrieved on shape queries.
  666. ----
  667. .. _class_Physics2DServer_method_body_set_shape_transform:
  668. - void **body_set_shape_transform** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_Transform2D>` transform **)**
  669. Sets the transform matrix for a body shape.
  670. ----
  671. .. _class_Physics2DServer_method_body_set_space:
  672. - void **body_set_space** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` space **)**
  673. Assigns a space to the body (see :ref:`space_create<class_Physics2DServer_method_space_create>`).
  674. ----
  675. .. _class_Physics2DServer_method_body_set_state:
  676. - void **body_set_state** **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_Physics2DServer_BodyState>` state, :ref:`Variant<class_Variant>` value **)**
  677. Sets a body state using one of the :ref:`BodyState<enum_Physics2DServer_BodyState>` constants.
  678. ----
  679. .. _class_Physics2DServer_method_body_test_motion:
  680. - :ref:`bool<class_bool>` **body_test_motion** **(** :ref:`RID<class_RID>` body, :ref:`Transform2D<class_Transform2D>` from, :ref:`Vector2<class_Vector2>` motion, :ref:`bool<class_bool>` infinite_inertia, :ref:`float<class_float>` margin=0.08, :ref:`Physics2DTestMotionResult<class_Physics2DTestMotionResult>` result=null **)**
  681. Returns ``true`` if a collision would result from moving in the given direction from a given point in space. Margin increases the size of the shapes involved in the collision detection. :ref:`Physics2DTestMotionResult<class_Physics2DTestMotionResult>` can be passed to return additional information in.
  682. ----
  683. .. _class_Physics2DServer_method_capsule_shape_create:
  684. - :ref:`RID<class_RID>` **capsule_shape_create** **(** **)**
  685. ----
  686. .. _class_Physics2DServer_method_circle_shape_create:
  687. - :ref:`RID<class_RID>` **circle_shape_create** **(** **)**
  688. ----
  689. .. _class_Physics2DServer_method_concave_polygon_shape_create:
  690. - :ref:`RID<class_RID>` **concave_polygon_shape_create** **(** **)**
  691. ----
  692. .. _class_Physics2DServer_method_convex_polygon_shape_create:
  693. - :ref:`RID<class_RID>` **convex_polygon_shape_create** **(** **)**
  694. ----
  695. .. _class_Physics2DServer_method_damped_spring_joint_create:
  696. - :ref:`RID<class_RID>` **damped_spring_joint_create** **(** :ref:`Vector2<class_Vector2>` anchor_a, :ref:`Vector2<class_Vector2>` anchor_b, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)**
  697. Creates a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself.
  698. ----
  699. .. _class_Physics2DServer_method_damped_string_joint_get_param:
  700. - :ref:`float<class_float>` **damped_string_joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`DampedStringParam<enum_Physics2DServer_DampedStringParam>` param **)** const
  701. Returns the value of a damped spring joint parameter.
  702. ----
  703. .. _class_Physics2DServer_method_damped_string_joint_set_param:
  704. - void **damped_string_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`DampedStringParam<enum_Physics2DServer_DampedStringParam>` param, :ref:`float<class_float>` value **)**
  705. Sets a damped spring joint parameter. See :ref:`DampedStringParam<enum_Physics2DServer_DampedStringParam>` for a list of available parameters.
  706. ----
  707. .. _class_Physics2DServer_method_free_rid:
  708. - void **free_rid** **(** :ref:`RID<class_RID>` rid **)**
  709. Destroys any of the objects created by Physics2DServer. If the :ref:`RID<class_RID>` passed is not one of the objects that can be created by Physics2DServer, an error will be sent to the console.
  710. ----
  711. .. _class_Physics2DServer_method_get_process_info:
  712. - :ref:`int<class_int>` **get_process_info** **(** :ref:`ProcessInfo<enum_Physics2DServer_ProcessInfo>` process_info **)**
  713. Returns information about the current state of the 2D physics engine. See :ref:`ProcessInfo<enum_Physics2DServer_ProcessInfo>` for a list of available states.
  714. ----
  715. .. _class_Physics2DServer_method_groove_joint_create:
  716. - :ref:`RID<class_RID>` **groove_joint_create** **(** :ref:`Vector2<class_Vector2>` groove1_a, :ref:`Vector2<class_Vector2>` groove2_a, :ref:`Vector2<class_Vector2>` anchor_b, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)**
  717. Creates a groove joint between two bodies. If not specified, the bodies are assumed to be the joint itself.
  718. ----
  719. .. _class_Physics2DServer_method_joint_get_param:
  720. - :ref:`float<class_float>` **joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_Physics2DServer_JointParam>` param **)** const
  721. Returns the value of a joint parameter.
  722. ----
  723. .. _class_Physics2DServer_method_joint_get_type:
  724. - :ref:`JointType<enum_Physics2DServer_JointType>` **joint_get_type** **(** :ref:`RID<class_RID>` joint **)** const
  725. Returns a joint's type (see :ref:`JointType<enum_Physics2DServer_JointType>`).
  726. ----
  727. .. _class_Physics2DServer_method_joint_set_param:
  728. - void **joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_Physics2DServer_JointParam>` param, :ref:`float<class_float>` value **)**
  729. Sets a joint parameter. See :ref:`JointParam<enum_Physics2DServer_JointParam>` for a list of available parameters.
  730. ----
  731. .. _class_Physics2DServer_method_line_shape_create:
  732. - :ref:`RID<class_RID>` **line_shape_create** **(** **)**
  733. ----
  734. .. _class_Physics2DServer_method_pin_joint_create:
  735. - :ref:`RID<class_RID>` **pin_joint_create** **(** :ref:`Vector2<class_Vector2>` anchor, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)**
  736. Creates a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself.
  737. ----
  738. .. _class_Physics2DServer_method_ray_shape_create:
  739. - :ref:`RID<class_RID>` **ray_shape_create** **(** **)**
  740. ----
  741. .. _class_Physics2DServer_method_rectangle_shape_create:
  742. - :ref:`RID<class_RID>` **rectangle_shape_create** **(** **)**
  743. ----
  744. .. _class_Physics2DServer_method_segment_shape_create:
  745. - :ref:`RID<class_RID>` **segment_shape_create** **(** **)**
  746. ----
  747. .. _class_Physics2DServer_method_set_active:
  748. - void **set_active** **(** :ref:`bool<class_bool>` active **)**
  749. Activates or deactivates the 2D physics engine.
  750. ----
  751. .. _class_Physics2DServer_method_shape_get_data:
  752. - :ref:`Variant<class_Variant>` **shape_get_data** **(** :ref:`RID<class_RID>` shape **)** const
  753. Returns the shape data.
  754. ----
  755. .. _class_Physics2DServer_method_shape_get_type:
  756. - :ref:`ShapeType<enum_Physics2DServer_ShapeType>` **shape_get_type** **(** :ref:`RID<class_RID>` shape **)** const
  757. Returns a shape's type (see :ref:`ShapeType<enum_Physics2DServer_ShapeType>`).
  758. ----
  759. .. _class_Physics2DServer_method_shape_set_data:
  760. - void **shape_set_data** **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_Variant>` data **)**
  761. Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created :ref:`shape_get_type<class_Physics2DServer_method_shape_get_type>`.
  762. ----
  763. .. _class_Physics2DServer_method_space_create:
  764. - :ref:`RID<class_RID>` **space_create** **(** **)**
  765. Creates a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with :ref:`area_set_space<class_Physics2DServer_method_area_set_space>`, or to a body with :ref:`body_set_space<class_Physics2DServer_method_body_set_space>`.
  766. ----
  767. .. _class_Physics2DServer_method_space_get_direct_state:
  768. - :ref:`Physics2DDirectSpaceState<class_Physics2DDirectSpaceState>` **space_get_direct_state** **(** :ref:`RID<class_RID>` space **)**
  769. Returns the state of a space, a :ref:`Physics2DDirectSpaceState<class_Physics2DDirectSpaceState>`. This object can be used to make collision/intersection queries.
  770. ----
  771. .. _class_Physics2DServer_method_space_get_param:
  772. - :ref:`float<class_float>` **space_get_param** **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_Physics2DServer_SpaceParameter>` param **)** const
  773. Returns the value of a space parameter.
  774. ----
  775. .. _class_Physics2DServer_method_space_is_active:
  776. - :ref:`bool<class_bool>` **space_is_active** **(** :ref:`RID<class_RID>` space **)** const
  777. Returns whether the space is active.
  778. ----
  779. .. _class_Physics2DServer_method_space_set_active:
  780. - void **space_set_active** **(** :ref:`RID<class_RID>` space, :ref:`bool<class_bool>` active **)**
  781. Marks a space as active. It will not have an effect, unless it is assigned to an area or body.
  782. ----
  783. .. _class_Physics2DServer_method_space_set_param:
  784. - void **space_set_param** **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_Physics2DServer_SpaceParameter>` param, :ref:`float<class_float>` value **)**
  785. Sets the value for a space parameter. See :ref:`SpaceParameter<enum_Physics2DServer_SpaceParameter>` for a list of available parameters.