class_physics2dserver.rst 166 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Physics2DServer.xml.
  6. .. _class_Physics2DServer:
  7. Physics2DServer
  8. ===============
  9. **Inherits:** :ref:`Object<class_Object>`
  10. Server interface for low-level 2D physics access.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. 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.
  15. .. rst-class:: classref-reftable-group
  16. Methods
  17. -------
  18. .. table::
  19. :widths: auto
  20. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | 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 **)** |
  22. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | 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 **)** |
  24. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | 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 **)** |
  26. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | void | :ref:`area_clear_shapes<class_Physics2DServer_method_area_clear_shapes>` **(** :ref:`RID<class_RID>` area **)** |
  28. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`RID<class_RID>` | :ref:`area_create<class_Physics2DServer_method_area_create>` **(** **)** |
  30. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`int<class_int>` | :ref:`area_get_canvas_instance_id<class_Physics2DServer_method_area_get_canvas_instance_id>` **(** :ref:`RID<class_RID>` area **)** |const| |
  32. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`int<class_int>` | :ref:`area_get_object_instance_id<class_Physics2DServer_method_area_get_object_instance_id>` **(** :ref:`RID<class_RID>` area **)** |const| |
  34. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | :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| |
  36. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | :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| |
  38. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | :ref:`int<class_int>` | :ref:`area_get_shape_count<class_Physics2DServer_method_area_get_shape_count>` **(** :ref:`RID<class_RID>` area **)** |const| |
  40. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :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| |
  42. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | :ref:`RID<class_RID>` | :ref:`area_get_space<class_Physics2DServer_method_area_get_space>` **(** :ref:`RID<class_RID>` area **)** |const| |
  44. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | :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| |
  46. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | :ref:`Transform2D<class_Transform2D>` | :ref:`area_get_transform<class_Physics2DServer_method_area_get_transform>` **(** :ref:`RID<class_RID>` area **)** |const| |
  48. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | void | :ref:`area_remove_shape<class_Physics2DServer_method_area_remove_shape>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |
  50. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | 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:`String<class_String>` method **)** |
  52. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | void | :ref:`area_set_collision_layer<class_Physics2DServer_method_area_set_collision_layer>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` layer **)** |
  54. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | void | :ref:`area_set_collision_mask<class_Physics2DServer_method_area_set_collision_mask>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` mask **)** |
  56. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | void | :ref:`area_set_monitor_callback<class_Physics2DServer_method_area_set_monitor_callback>` **(** :ref:`RID<class_RID>` area, :ref:`Object<class_Object>` receiver, :ref:`String<class_String>` method **)** |
  58. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | void | :ref:`area_set_monitorable<class_Physics2DServer_method_area_set_monitorable>` **(** :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` monitorable **)** |
  60. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | 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 **)** |
  62. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | 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 **)** |
  64. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | 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 **)** |
  66. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | 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 **)** |
  68. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | void | :ref:`area_set_space<class_Physics2DServer_method_area_set_space>` **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` space **)** |
  70. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | 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 **)** |
  72. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | void | :ref:`area_set_transform<class_Physics2DServer_method_area_set_transform>` **(** :ref:`RID<class_RID>` area, :ref:`Transform2D<class_Transform2D>` transform **)** |
  74. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | void | :ref:`body_add_central_force<class_Physics2DServer_method_body_add_central_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)** |
  76. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | void | :ref:`body_add_collision_exception<class_Physics2DServer_method_body_add_collision_exception>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)** |
  78. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | 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 **)** |
  80. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | 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 **)** |
  82. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | void | :ref:`body_add_torque<class_Physics2DServer_method_body_add_torque>` **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)** |
  84. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | void | :ref:`body_apply_central_impulse<class_Physics2DServer_method_body_apply_central_impulse>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` impulse **)** |
  86. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | 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 **)** |
  88. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | void | :ref:`body_apply_torque_impulse<class_Physics2DServer_method_body_apply_torque_impulse>` **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` impulse **)** |
  90. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | 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 **)** |
  92. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | 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 **)** |
  94. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | void | :ref:`body_clear_shapes<class_Physics2DServer_method_body_clear_shapes>` **(** :ref:`RID<class_RID>` body **)** |
  96. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | :ref:`RID<class_RID>` | :ref:`body_create<class_Physics2DServer_method_body_create>` **(** **)** |
  98. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | :ref:`int<class_int>` | :ref:`body_get_canvas_instance_id<class_Physics2DServer_method_body_get_canvas_instance_id>` **(** :ref:`RID<class_RID>` body **)** |const| |
  100. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | :ref:`int<class_int>` | :ref:`body_get_collision_layer<class_Physics2DServer_method_body_get_collision_layer>` **(** :ref:`RID<class_RID>` body **)** |const| |
  102. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | :ref:`int<class_int>` | :ref:`body_get_collision_mask<class_Physics2DServer_method_body_get_collision_mask>` **(** :ref:`RID<class_RID>` body **)** |const| |
  104. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | :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| |
  106. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | :ref:`Physics2DDirectBodyState<class_Physics2DDirectBodyState>` | :ref:`body_get_direct_state<class_Physics2DServer_method_body_get_direct_state>` **(** :ref:`RID<class_RID>` body **)** |
  108. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | :ref:`int<class_int>` | :ref:`body_get_max_contacts_reported<class_Physics2DServer_method_body_get_max_contacts_reported>` **(** :ref:`RID<class_RID>` body **)** |const| |
  110. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | :ref:`BodyMode<enum_Physics2DServer_BodyMode>` | :ref:`body_get_mode<class_Physics2DServer_method_body_get_mode>` **(** :ref:`RID<class_RID>` body **)** |const| |
  112. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | :ref:`int<class_int>` | :ref:`body_get_object_instance_id<class_Physics2DServer_method_body_get_object_instance_id>` **(** :ref:`RID<class_RID>` body **)** |const| |
  114. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | :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| |
  116. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | :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| |
  118. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | :ref:`int<class_int>` | :ref:`body_get_shape_count<class_Physics2DServer_method_body_get_shape_count>` **(** :ref:`RID<class_RID>` body **)** |const| |
  120. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | :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| |
  122. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | :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| |
  124. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | :ref:`RID<class_RID>` | :ref:`body_get_space<class_Physics2DServer_method_body_get_space>` **(** :ref:`RID<class_RID>` body **)** |const| |
  126. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | :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| |
  128. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | :ref:`bool<class_bool>` | :ref:`body_is_omitting_force_integration<class_Physics2DServer_method_body_is_omitting_force_integration>` **(** :ref:`RID<class_RID>` body **)** |const| |
  130. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | void | :ref:`body_remove_collision_exception<class_Physics2DServer_method_body_remove_collision_exception>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)** |
  132. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | void | :ref:`body_remove_shape<class_Physics2DServer_method_body_remove_shape>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |
  134. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | void | :ref:`body_set_axis_velocity<class_Physics2DServer_method_body_set_axis_velocity>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` axis_velocity **)** |
  136. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | void | :ref:`body_set_collision_layer<class_Physics2DServer_method_body_set_collision_layer>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` layer **)** |
  138. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | void | :ref:`body_set_collision_mask<class_Physics2DServer_method_body_set_collision_mask>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` mask **)** |
  140. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | 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 **)** |
  142. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | 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:`String<class_String>` method, :ref:`Variant<class_Variant>` userdata=null **)** |
  144. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | 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 **)** |
  146. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | void | :ref:`body_set_mode<class_Physics2DServer_method_body_set_mode>` **(** :ref:`RID<class_RID>` body, :ref:`BodyMode<enum_Physics2DServer_BodyMode>` mode **)** |
  148. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | 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 **)** |
  150. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | 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 **)** |
  152. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | 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 **)** |
  154. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | 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 **)** |
  156. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | 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 **)** |
  158. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | 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 **)** |
  160. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | 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 **)** |
  162. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | void | :ref:`body_set_space<class_Physics2DServer_method_body_set_space>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` space **)** |
  164. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. | 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 **)** |
  166. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  167. | :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, :ref:`bool<class_bool>` exclude_raycast_shapes=true, :ref:`Array<class_Array>` exclude=[ ] **)** |
  168. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  169. | :ref:`RID<class_RID>` | :ref:`capsule_shape_create<class_Physics2DServer_method_capsule_shape_create>` **(** **)** |
  170. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  171. | :ref:`RID<class_RID>` | :ref:`circle_shape_create<class_Physics2DServer_method_circle_shape_create>` **(** **)** |
  172. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  173. | :ref:`RID<class_RID>` | :ref:`concave_polygon_shape_create<class_Physics2DServer_method_concave_polygon_shape_create>` **(** **)** |
  174. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  175. | :ref:`RID<class_RID>` | :ref:`convex_polygon_shape_create<class_Physics2DServer_method_convex_polygon_shape_create>` **(** **)** |
  176. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  177. | :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 **)** |
  178. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  179. | :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| |
  180. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  181. | 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 **)** |
  182. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | void | :ref:`free_rid<class_Physics2DServer_method_free_rid>` **(** :ref:`RID<class_RID>` rid **)** |
  184. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | :ref:`int<class_int>` | :ref:`get_process_info<class_Physics2DServer_method_get_process_info>` **(** :ref:`ProcessInfo<enum_Physics2DServer_ProcessInfo>` process_info **)** |
  186. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | :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 **)** |
  188. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | :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| |
  190. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | :ref:`JointType<enum_Physics2DServer_JointType>` | :ref:`joint_get_type<class_Physics2DServer_method_joint_get_type>` **(** :ref:`RID<class_RID>` joint **)** |const| |
  192. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | 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 **)** |
  194. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | :ref:`RID<class_RID>` | :ref:`line_shape_create<class_Physics2DServer_method_line_shape_create>` **(** **)** |
  196. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | :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 **)** |
  198. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | :ref:`RID<class_RID>` | :ref:`ray_shape_create<class_Physics2DServer_method_ray_shape_create>` **(** **)** |
  200. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | :ref:`RID<class_RID>` | :ref:`rectangle_shape_create<class_Physics2DServer_method_rectangle_shape_create>` **(** **)** |
  202. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | :ref:`RID<class_RID>` | :ref:`segment_shape_create<class_Physics2DServer_method_segment_shape_create>` **(** **)** |
  204. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | void | :ref:`set_active<class_Physics2DServer_method_set_active>` **(** :ref:`bool<class_bool>` active **)** |
  206. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | void | :ref:`set_collision_iterations<class_Physics2DServer_method_set_collision_iterations>` **(** :ref:`int<class_int>` iterations **)** |
  208. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | :ref:`Variant<class_Variant>` | :ref:`shape_get_data<class_Physics2DServer_method_shape_get_data>` **(** :ref:`RID<class_RID>` shape **)** |const| |
  210. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | :ref:`ShapeType<enum_Physics2DServer_ShapeType>` | :ref:`shape_get_type<class_Physics2DServer_method_shape_get_type>` **(** :ref:`RID<class_RID>` shape **)** |const| |
  212. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. | void | :ref:`shape_set_data<class_Physics2DServer_method_shape_set_data>` **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_Variant>` data **)** |
  214. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  215. | :ref:`RID<class_RID>` | :ref:`space_create<class_Physics2DServer_method_space_create>` **(** **)** |
  216. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  217. | :ref:`Physics2DDirectSpaceState<class_Physics2DDirectSpaceState>` | :ref:`space_get_direct_state<class_Physics2DServer_method_space_get_direct_state>` **(** :ref:`RID<class_RID>` space **)** |
  218. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  219. | :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| |
  220. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  221. | :ref:`bool<class_bool>` | :ref:`space_is_active<class_Physics2DServer_method_space_is_active>` **(** :ref:`RID<class_RID>` space **)** |const| |
  222. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  223. | void | :ref:`space_set_active<class_Physics2DServer_method_space_set_active>` **(** :ref:`RID<class_RID>` space, :ref:`bool<class_bool>` active **)** |
  224. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  225. | 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 **)** |
  226. +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  227. .. rst-class:: classref-section-separator
  228. ----
  229. .. rst-class:: classref-descriptions-group
  230. Enumerations
  231. ------------
  232. .. _enum_Physics2DServer_SpaceParameter:
  233. .. rst-class:: classref-enumeration
  234. enum **SpaceParameter**:
  235. .. _class_Physics2DServer_constant_SPACE_PARAM_CONTACT_RECYCLE_RADIUS:
  236. .. rst-class:: classref-enumeration-constant
  237. :ref:`SpaceParameter<enum_Physics2DServer_SpaceParameter>` **SPACE_PARAM_CONTACT_RECYCLE_RADIUS** = ``0``
  238. Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated.
  239. .. _class_Physics2DServer_constant_SPACE_PARAM_CONTACT_MAX_SEPARATION:
  240. .. rst-class:: classref-enumeration-constant
  241. :ref:`SpaceParameter<enum_Physics2DServer_SpaceParameter>` **SPACE_PARAM_CONTACT_MAX_SEPARATION** = ``1``
  242. Constant to set/get the maximum distance a shape can be from another before they are considered separated.
  243. .. _class_Physics2DServer_constant_SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION:
  244. .. rst-class:: classref-enumeration-constant
  245. :ref:`SpaceParameter<enum_Physics2DServer_SpaceParameter>` **SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION** = ``2``
  246. Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision.
  247. .. _class_Physics2DServer_constant_SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD:
  248. .. rst-class:: classref-enumeration-constant
  249. :ref:`SpaceParameter<enum_Physics2DServer_SpaceParameter>` **SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD** = ``3``
  250. 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.
  251. .. _class_Physics2DServer_constant_SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD:
  252. .. rst-class:: classref-enumeration-constant
  253. :ref:`SpaceParameter<enum_Physics2DServer_SpaceParameter>` **SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD** = ``4``
  254. 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.
  255. .. _class_Physics2DServer_constant_SPACE_PARAM_BODY_TIME_TO_SLEEP:
  256. .. rst-class:: classref-enumeration-constant
  257. :ref:`SpaceParameter<enum_Physics2DServer_SpaceParameter>` **SPACE_PARAM_BODY_TIME_TO_SLEEP** = ``5``
  258. 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.
  259. .. _class_Physics2DServer_constant_SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS:
  260. .. rst-class:: classref-enumeration-constant
  261. :ref:`SpaceParameter<enum_Physics2DServer_SpaceParameter>` **SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS** = ``6``
  262. 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.
  263. .. rst-class:: classref-item-separator
  264. ----
  265. .. _enum_Physics2DServer_ShapeType:
  266. .. rst-class:: classref-enumeration
  267. enum **ShapeType**:
  268. .. _class_Physics2DServer_constant_SHAPE_LINE:
  269. .. rst-class:: classref-enumeration-constant
  270. :ref:`ShapeType<enum_Physics2DServer_ShapeType>` **SHAPE_LINE** = ``0``
  271. 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.
  272. .. _class_Physics2DServer_constant_SHAPE_RAY:
  273. .. rst-class:: classref-enumeration-constant
  274. :ref:`ShapeType<enum_Physics2DServer_ShapeType>` **SHAPE_RAY** = ``1``
  275. .. _class_Physics2DServer_constant_SHAPE_SEGMENT:
  276. .. rst-class:: classref-enumeration-constant
  277. :ref:`ShapeType<enum_Physics2DServer_ShapeType>` **SHAPE_SEGMENT** = ``2``
  278. 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.
  279. .. _class_Physics2DServer_constant_SHAPE_CIRCLE:
  280. .. rst-class:: classref-enumeration-constant
  281. :ref:`ShapeType<enum_Physics2DServer_ShapeType>` **SHAPE_CIRCLE** = ``3``
  282. 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.
  283. .. _class_Physics2DServer_constant_SHAPE_RECTANGLE:
  284. .. rst-class:: classref-enumeration-constant
  285. :ref:`ShapeType<enum_Physics2DServer_ShapeType>` **SHAPE_RECTANGLE** = ``4``
  286. 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.
  287. .. _class_Physics2DServer_constant_SHAPE_CAPSULE:
  288. .. rst-class:: classref-enumeration-constant
  289. :ref:`ShapeType<enum_Physics2DServer_ShapeType>` **SHAPE_CAPSULE** = ``5``
  290. 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.
  291. .. _class_Physics2DServer_constant_SHAPE_CONVEX_POLYGON:
  292. .. rst-class:: classref-enumeration-constant
  293. :ref:`ShapeType<enum_Physics2DServer_ShapeType>` **SHAPE_CONVEX_POLYGON** = ``6``
  294. 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.
  295. .. _class_Physics2DServer_constant_SHAPE_CONCAVE_POLYGON:
  296. .. rst-class:: classref-enumeration-constant
  297. :ref:`ShapeType<enum_Physics2DServer_ShapeType>` **SHAPE_CONCAVE_POLYGON** = ``7``
  298. 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.
  299. .. _class_Physics2DServer_constant_SHAPE_CUSTOM:
  300. .. rst-class:: classref-enumeration-constant
  301. :ref:`ShapeType<enum_Physics2DServer_ShapeType>` **SHAPE_CUSTOM** = ``8``
  302. This constant is used internally by the engine. Any attempt to create this kind of shape results in an error.
  303. .. rst-class:: classref-item-separator
  304. ----
  305. .. _enum_Physics2DServer_AreaParameter:
  306. .. rst-class:: classref-enumeration
  307. enum **AreaParameter**:
  308. .. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY:
  309. .. rst-class:: classref-enumeration-constant
  310. :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` **AREA_PARAM_GRAVITY** = ``0``
  311. Constant to set/get gravity strength in an area.
  312. .. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY_VECTOR:
  313. .. rst-class:: classref-enumeration-constant
  314. :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` **AREA_PARAM_GRAVITY_VECTOR** = ``1``
  315. Constant to set/get gravity vector/center in an area.
  316. .. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY_IS_POINT:
  317. .. rst-class:: classref-enumeration-constant
  318. :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` **AREA_PARAM_GRAVITY_IS_POINT** = ``2``
  319. Constant to set/get whether the gravity vector of an area is a direction, or a center point.
  320. .. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY_DISTANCE_SCALE:
  321. .. rst-class:: classref-enumeration-constant
  322. :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` **AREA_PARAM_GRAVITY_DISTANCE_SCALE** = ``3``
  323. 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.
  324. .. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY_POINT_ATTENUATION:
  325. .. rst-class:: classref-enumeration-constant
  326. :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` **AREA_PARAM_GRAVITY_POINT_ATTENUATION** = ``4``
  327. 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>`.
  328. .. _class_Physics2DServer_constant_AREA_PARAM_LINEAR_DAMP:
  329. .. rst-class:: classref-enumeration-constant
  330. :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` **AREA_PARAM_LINEAR_DAMP** = ``5``
  331. Constant to set/get the linear dampening factor of an area.
  332. .. _class_Physics2DServer_constant_AREA_PARAM_ANGULAR_DAMP:
  333. .. rst-class:: classref-enumeration-constant
  334. :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` **AREA_PARAM_ANGULAR_DAMP** = ``6``
  335. Constant to set/get the angular dampening factor of an area.
  336. .. _class_Physics2DServer_constant_AREA_PARAM_PRIORITY:
  337. .. rst-class:: classref-enumeration-constant
  338. :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` **AREA_PARAM_PRIORITY** = ``7``
  339. Constant to set/get the priority (order of processing) of an area.
  340. .. rst-class:: classref-item-separator
  341. ----
  342. .. _enum_Physics2DServer_AreaSpaceOverrideMode:
  343. .. rst-class:: classref-enumeration
  344. enum **AreaSpaceOverrideMode**:
  345. .. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_DISABLED:
  346. .. rst-class:: classref-enumeration-constant
  347. :ref:`AreaSpaceOverrideMode<enum_Physics2DServer_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_DISABLED** = ``0``
  348. This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
  349. .. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_COMBINE:
  350. .. rst-class:: classref-enumeration-constant
  351. :ref:`AreaSpaceOverrideMode<enum_Physics2DServer_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_COMBINE** = ``1``
  352. 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.
  353. .. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_COMBINE_REPLACE:
  354. .. rst-class:: classref-enumeration-constant
  355. :ref:`AreaSpaceOverrideMode<enum_Physics2DServer_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_COMBINE_REPLACE** = ``2``
  356. 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.
  357. .. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_REPLACE:
  358. .. rst-class:: classref-enumeration-constant
  359. :ref:`AreaSpaceOverrideMode<enum_Physics2DServer_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_REPLACE** = ``3``
  360. This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
  361. .. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_REPLACE_COMBINE:
  362. .. rst-class:: classref-enumeration-constant
  363. :ref:`AreaSpaceOverrideMode<enum_Physics2DServer_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_REPLACE_COMBINE** = ``4``
  364. This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
  365. .. rst-class:: classref-item-separator
  366. ----
  367. .. _enum_Physics2DServer_BodyMode:
  368. .. rst-class:: classref-enumeration
  369. enum **BodyMode**:
  370. .. _class_Physics2DServer_constant_BODY_MODE_STATIC:
  371. .. rst-class:: classref-enumeration-constant
  372. :ref:`BodyMode<enum_Physics2DServer_BodyMode>` **BODY_MODE_STATIC** = ``0``
  373. Constant for static bodies.
  374. .. _class_Physics2DServer_constant_BODY_MODE_KINEMATIC:
  375. .. rst-class:: classref-enumeration-constant
  376. :ref:`BodyMode<enum_Physics2DServer_BodyMode>` **BODY_MODE_KINEMATIC** = ``1``
  377. Constant for kinematic bodies.
  378. .. _class_Physics2DServer_constant_BODY_MODE_RIGID:
  379. .. rst-class:: classref-enumeration-constant
  380. :ref:`BodyMode<enum_Physics2DServer_BodyMode>` **BODY_MODE_RIGID** = ``2``
  381. Constant for rigid bodies.
  382. .. _class_Physics2DServer_constant_BODY_MODE_CHARACTER:
  383. .. rst-class:: classref-enumeration-constant
  384. :ref:`BodyMode<enum_Physics2DServer_BodyMode>` **BODY_MODE_CHARACTER** = ``3``
  385. Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics.
  386. .. rst-class:: classref-item-separator
  387. ----
  388. .. _enum_Physics2DServer_BodyParameter:
  389. .. rst-class:: classref-enumeration
  390. enum **BodyParameter**:
  391. .. _class_Physics2DServer_constant_BODY_PARAM_BOUNCE:
  392. .. rst-class:: classref-enumeration-constant
  393. :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` **BODY_PARAM_BOUNCE** = ``0``
  394. Constant to set/get a body's bounce factor.
  395. .. _class_Physics2DServer_constant_BODY_PARAM_FRICTION:
  396. .. rst-class:: classref-enumeration-constant
  397. :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` **BODY_PARAM_FRICTION** = ``1``
  398. Constant to set/get a body's friction.
  399. .. _class_Physics2DServer_constant_BODY_PARAM_MASS:
  400. .. rst-class:: classref-enumeration-constant
  401. :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` **BODY_PARAM_MASS** = ``2``
  402. Constant to set/get a body's mass.
  403. .. _class_Physics2DServer_constant_BODY_PARAM_INERTIA:
  404. .. rst-class:: classref-enumeration-constant
  405. :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` **BODY_PARAM_INERTIA** = ``3``
  406. Constant to set/get a body's inertia.
  407. .. _class_Physics2DServer_constant_BODY_PARAM_GRAVITY_SCALE:
  408. .. rst-class:: classref-enumeration-constant
  409. :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` **BODY_PARAM_GRAVITY_SCALE** = ``4``
  410. Constant to set/get a body's gravity multiplier.
  411. .. _class_Physics2DServer_constant_BODY_PARAM_LINEAR_DAMP:
  412. .. rst-class:: classref-enumeration-constant
  413. :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` **BODY_PARAM_LINEAR_DAMP** = ``5``
  414. Constant to set/get a body's linear dampening factor.
  415. .. _class_Physics2DServer_constant_BODY_PARAM_ANGULAR_DAMP:
  416. .. rst-class:: classref-enumeration-constant
  417. :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` **BODY_PARAM_ANGULAR_DAMP** = ``6``
  418. Constant to set/get a body's angular dampening factor.
  419. .. _class_Physics2DServer_constant_BODY_PARAM_MAX:
  420. .. rst-class:: classref-enumeration-constant
  421. :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` **BODY_PARAM_MAX** = ``7``
  422. Represents the size of the :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` enum.
  423. .. rst-class:: classref-item-separator
  424. ----
  425. .. _enum_Physics2DServer_BodyState:
  426. .. rst-class:: classref-enumeration
  427. enum **BodyState**:
  428. .. _class_Physics2DServer_constant_BODY_STATE_TRANSFORM:
  429. .. rst-class:: classref-enumeration-constant
  430. :ref:`BodyState<enum_Physics2DServer_BodyState>` **BODY_STATE_TRANSFORM** = ``0``
  431. Constant to set/get the current transform matrix of the body.
  432. .. _class_Physics2DServer_constant_BODY_STATE_LINEAR_VELOCITY:
  433. .. rst-class:: classref-enumeration-constant
  434. :ref:`BodyState<enum_Physics2DServer_BodyState>` **BODY_STATE_LINEAR_VELOCITY** = ``1``
  435. Constant to set/get the current linear velocity of the body.
  436. .. _class_Physics2DServer_constant_BODY_STATE_ANGULAR_VELOCITY:
  437. .. rst-class:: classref-enumeration-constant
  438. :ref:`BodyState<enum_Physics2DServer_BodyState>` **BODY_STATE_ANGULAR_VELOCITY** = ``2``
  439. Constant to set/get the current angular velocity of the body.
  440. .. _class_Physics2DServer_constant_BODY_STATE_SLEEPING:
  441. .. rst-class:: classref-enumeration-constant
  442. :ref:`BodyState<enum_Physics2DServer_BodyState>` **BODY_STATE_SLEEPING** = ``3``
  443. Constant to sleep/wake up a body, or to get whether it is sleeping.
  444. .. _class_Physics2DServer_constant_BODY_STATE_CAN_SLEEP:
  445. .. rst-class:: classref-enumeration-constant
  446. :ref:`BodyState<enum_Physics2DServer_BodyState>` **BODY_STATE_CAN_SLEEP** = ``4``
  447. Constant to set/get whether the body can sleep.
  448. .. rst-class:: classref-item-separator
  449. ----
  450. .. _enum_Physics2DServer_JointType:
  451. .. rst-class:: classref-enumeration
  452. enum **JointType**:
  453. .. _class_Physics2DServer_constant_JOINT_PIN:
  454. .. rst-class:: classref-enumeration-constant
  455. :ref:`JointType<enum_Physics2DServer_JointType>` **JOINT_PIN** = ``0``
  456. Constant to create pin joints.
  457. .. _class_Physics2DServer_constant_JOINT_GROOVE:
  458. .. rst-class:: classref-enumeration-constant
  459. :ref:`JointType<enum_Physics2DServer_JointType>` **JOINT_GROOVE** = ``1``
  460. Constant to create groove joints.
  461. .. _class_Physics2DServer_constant_JOINT_DAMPED_SPRING:
  462. .. rst-class:: classref-enumeration-constant
  463. :ref:`JointType<enum_Physics2DServer_JointType>` **JOINT_DAMPED_SPRING** = ``2``
  464. Constant to create damped spring joints.
  465. .. rst-class:: classref-item-separator
  466. ----
  467. .. _enum_Physics2DServer_JointParam:
  468. .. rst-class:: classref-enumeration
  469. enum **JointParam**:
  470. .. _class_Physics2DServer_constant_JOINT_PARAM_BIAS:
  471. .. rst-class:: classref-enumeration-constant
  472. :ref:`JointParam<enum_Physics2DServer_JointParam>` **JOINT_PARAM_BIAS** = ``0``
  473. .. _class_Physics2DServer_constant_JOINT_PARAM_MAX_BIAS:
  474. .. rst-class:: classref-enumeration-constant
  475. :ref:`JointParam<enum_Physics2DServer_JointParam>` **JOINT_PARAM_MAX_BIAS** = ``1``
  476. .. _class_Physics2DServer_constant_JOINT_PARAM_MAX_FORCE:
  477. .. rst-class:: classref-enumeration-constant
  478. :ref:`JointParam<enum_Physics2DServer_JointParam>` **JOINT_PARAM_MAX_FORCE** = ``2``
  479. .. rst-class:: classref-item-separator
  480. ----
  481. .. _enum_Physics2DServer_DampedStringParam:
  482. .. rst-class:: classref-enumeration
  483. enum **DampedStringParam**:
  484. .. _class_Physics2DServer_constant_DAMPED_STRING_REST_LENGTH:
  485. .. rst-class:: classref-enumeration-constant
  486. :ref:`DampedStringParam<enum_Physics2DServer_DampedStringParam>` **DAMPED_STRING_REST_LENGTH** = ``0``
  487. Sets the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
  488. .. _class_Physics2DServer_constant_DAMPED_STRING_STIFFNESS:
  489. .. rst-class:: classref-enumeration-constant
  490. :ref:`DampedStringParam<enum_Physics2DServer_DampedStringParam>` **DAMPED_STRING_STIFFNESS** = ``1``
  491. Sets the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
  492. .. _class_Physics2DServer_constant_DAMPED_STRING_DAMPING:
  493. .. rst-class:: classref-enumeration-constant
  494. :ref:`DampedStringParam<enum_Physics2DServer_DampedStringParam>` **DAMPED_STRING_DAMPING** = ``2``
  495. 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).
  496. .. rst-class:: classref-item-separator
  497. ----
  498. .. _enum_Physics2DServer_CCDMode:
  499. .. rst-class:: classref-enumeration
  500. enum **CCDMode**:
  501. .. _class_Physics2DServer_constant_CCD_MODE_DISABLED:
  502. .. rst-class:: classref-enumeration-constant
  503. :ref:`CCDMode<enum_Physics2DServer_CCDMode>` **CCD_MODE_DISABLED** = ``0``
  504. Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects.
  505. .. _class_Physics2DServer_constant_CCD_MODE_CAST_RAY:
  506. .. rst-class:: classref-enumeration-constant
  507. :ref:`CCDMode<enum_Physics2DServer_CCDMode>` **CCD_MODE_CAST_RAY** = ``1``
  508. Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise.
  509. .. _class_Physics2DServer_constant_CCD_MODE_CAST_SHAPE:
  510. .. rst-class:: classref-enumeration-constant
  511. :ref:`CCDMode<enum_Physics2DServer_CCDMode>` **CCD_MODE_CAST_SHAPE** = ``2``
  512. Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise.
  513. .. rst-class:: classref-item-separator
  514. ----
  515. .. _enum_Physics2DServer_AreaBodyStatus:
  516. .. rst-class:: classref-enumeration
  517. enum **AreaBodyStatus**:
  518. .. _class_Physics2DServer_constant_AREA_BODY_ADDED:
  519. .. rst-class:: classref-enumeration-constant
  520. :ref:`AreaBodyStatus<enum_Physics2DServer_AreaBodyStatus>` **AREA_BODY_ADDED** = ``0``
  521. The value of the first parameter and area callback function receives, when an object enters one of its shapes.
  522. .. _class_Physics2DServer_constant_AREA_BODY_REMOVED:
  523. .. rst-class:: classref-enumeration-constant
  524. :ref:`AreaBodyStatus<enum_Physics2DServer_AreaBodyStatus>` **AREA_BODY_REMOVED** = ``1``
  525. The value of the first parameter and area callback function receives, when an object exits one of its shapes.
  526. .. rst-class:: classref-item-separator
  527. ----
  528. .. _enum_Physics2DServer_ProcessInfo:
  529. .. rst-class:: classref-enumeration
  530. enum **ProcessInfo**:
  531. .. _class_Physics2DServer_constant_INFO_ACTIVE_OBJECTS:
  532. .. rst-class:: classref-enumeration-constant
  533. :ref:`ProcessInfo<enum_Physics2DServer_ProcessInfo>` **INFO_ACTIVE_OBJECTS** = ``0``
  534. Constant to get the number of objects that are not sleeping.
  535. .. _class_Physics2DServer_constant_INFO_COLLISION_PAIRS:
  536. .. rst-class:: classref-enumeration-constant
  537. :ref:`ProcessInfo<enum_Physics2DServer_ProcessInfo>` **INFO_COLLISION_PAIRS** = ``1``
  538. Constant to get the number of possible collisions.
  539. .. _class_Physics2DServer_constant_INFO_ISLAND_COUNT:
  540. .. rst-class:: classref-enumeration-constant
  541. :ref:`ProcessInfo<enum_Physics2DServer_ProcessInfo>` **INFO_ISLAND_COUNT** = ``2``
  542. Constant to get the number of space regions where a collision could occur.
  543. .. rst-class:: classref-section-separator
  544. ----
  545. .. rst-class:: classref-descriptions-group
  546. Method Descriptions
  547. -------------------
  548. .. _class_Physics2DServer_method_area_add_shape:
  549. .. rst-class:: classref-method
  550. 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 **)**
  551. 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.
  552. .. rst-class:: classref-item-separator
  553. ----
  554. .. _class_Physics2DServer_method_area_attach_canvas_instance_id:
  555. .. rst-class:: classref-method
  556. void **area_attach_canvas_instance_id** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)**
  557. .. container:: contribute
  558. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  559. .. rst-class:: classref-item-separator
  560. ----
  561. .. _class_Physics2DServer_method_area_attach_object_instance_id:
  562. .. rst-class:: classref-method
  563. void **area_attach_object_instance_id** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)**
  564. Assigns the area to a descendant of :ref:`Object<class_Object>`, so it can exist in the node tree.
  565. .. rst-class:: classref-item-separator
  566. ----
  567. .. _class_Physics2DServer_method_area_clear_shapes:
  568. .. rst-class:: classref-method
  569. void **area_clear_shapes** **(** :ref:`RID<class_RID>` area **)**
  570. Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later.
  571. .. rst-class:: classref-item-separator
  572. ----
  573. .. _class_Physics2DServer_method_area_create:
  574. .. rst-class:: classref-method
  575. :ref:`RID<class_RID>` **area_create** **(** **)**
  576. Creates an :ref:`Area2D<class_Area2D>`. After creating an :ref:`Area2D<class_Area2D>` with this method, assign it to a space using :ref:`area_set_space<class_Physics2DServer_method_area_set_space>` to use the created :ref:`Area2D<class_Area2D>` in the physics world.
  577. .. rst-class:: classref-item-separator
  578. ----
  579. .. _class_Physics2DServer_method_area_get_canvas_instance_id:
  580. .. rst-class:: classref-method
  581. :ref:`int<class_int>` **area_get_canvas_instance_id** **(** :ref:`RID<class_RID>` area **)** |const|
  582. .. container:: contribute
  583. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  584. .. rst-class:: classref-item-separator
  585. ----
  586. .. _class_Physics2DServer_method_area_get_object_instance_id:
  587. .. rst-class:: classref-method
  588. :ref:`int<class_int>` **area_get_object_instance_id** **(** :ref:`RID<class_RID>` area **)** |const|
  589. Gets the instance ID of the object the area is assigned to.
  590. .. rst-class:: classref-item-separator
  591. ----
  592. .. _class_Physics2DServer_method_area_get_param:
  593. .. rst-class:: classref-method
  594. :ref:`Variant<class_Variant>` **area_get_param** **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` param **)** |const|
  595. Returns an area parameter value. See :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` for a list of available parameters.
  596. .. rst-class:: classref-item-separator
  597. ----
  598. .. _class_Physics2DServer_method_area_get_shape:
  599. .. rst-class:: classref-method
  600. :ref:`RID<class_RID>` **area_get_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |const|
  601. Returns the :ref:`RID<class_RID>` of the nth shape of an area.
  602. .. rst-class:: classref-item-separator
  603. ----
  604. .. _class_Physics2DServer_method_area_get_shape_count:
  605. .. rst-class:: classref-method
  606. :ref:`int<class_int>` **area_get_shape_count** **(** :ref:`RID<class_RID>` area **)** |const|
  607. Returns the number of shapes assigned to an area.
  608. .. rst-class:: classref-item-separator
  609. ----
  610. .. _class_Physics2DServer_method_area_get_shape_transform:
  611. .. rst-class:: classref-method
  612. :ref:`Transform2D<class_Transform2D>` **area_get_shape_transform** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |const|
  613. Returns the transform matrix of a shape within an area.
  614. .. rst-class:: classref-item-separator
  615. ----
  616. .. _class_Physics2DServer_method_area_get_space:
  617. .. rst-class:: classref-method
  618. :ref:`RID<class_RID>` **area_get_space** **(** :ref:`RID<class_RID>` area **)** |const|
  619. Returns the space assigned to the area.
  620. .. rst-class:: classref-item-separator
  621. ----
  622. .. _class_Physics2DServer_method_area_get_space_override_mode:
  623. .. rst-class:: classref-method
  624. :ref:`AreaSpaceOverrideMode<enum_Physics2DServer_AreaSpaceOverrideMode>` **area_get_space_override_mode** **(** :ref:`RID<class_RID>` area **)** |const|
  625. Returns the space override mode for the area.
  626. .. rst-class:: classref-item-separator
  627. ----
  628. .. _class_Physics2DServer_method_area_get_transform:
  629. .. rst-class:: classref-method
  630. :ref:`Transform2D<class_Transform2D>` **area_get_transform** **(** :ref:`RID<class_RID>` area **)** |const|
  631. Returns the transform matrix for an area.
  632. .. rst-class:: classref-item-separator
  633. ----
  634. .. _class_Physics2DServer_method_area_remove_shape:
  635. .. rst-class:: classref-method
  636. void **area_remove_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)**
  637. Removes a shape from an area. It does not delete the shape, so it can be reassigned later.
  638. .. rst-class:: classref-item-separator
  639. ----
  640. .. _class_Physics2DServer_method_area_set_area_monitor_callback:
  641. .. rst-class:: classref-method
  642. void **area_set_area_monitor_callback** **(** :ref:`RID<class_RID>` area, :ref:`Object<class_Object>` receiver, :ref:`String<class_String>` method **)**
  643. .. container:: contribute
  644. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  645. .. rst-class:: classref-item-separator
  646. ----
  647. .. _class_Physics2DServer_method_area_set_collision_layer:
  648. .. rst-class:: classref-method
  649. void **area_set_collision_layer** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` layer **)**
  650. Assigns the area to one or many physics layers.
  651. .. rst-class:: classref-item-separator
  652. ----
  653. .. _class_Physics2DServer_method_area_set_collision_mask:
  654. .. rst-class:: classref-method
  655. void **area_set_collision_mask** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` mask **)**
  656. Sets which physics layers the area will monitor.
  657. .. rst-class:: classref-item-separator
  658. ----
  659. .. _class_Physics2DServer_method_area_set_monitor_callback:
  660. .. rst-class:: classref-method
  661. void **area_set_monitor_callback** **(** :ref:`RID<class_RID>` area, :ref:`Object<class_Object>` receiver, :ref:`String<class_String>` method **)**
  662. 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:
  663. 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.
  664. 2: :ref:`RID<class_RID>` of the object that entered/exited the area.
  665. 3: Instance ID of the object that entered/exited the area.
  666. 4: The shape index of the object that entered/exited the area.
  667. 5: The shape index of the area where the object entered/exited.
  668. .. rst-class:: classref-item-separator
  669. ----
  670. .. _class_Physics2DServer_method_area_set_monitorable:
  671. .. rst-class:: classref-method
  672. void **area_set_monitorable** **(** :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` monitorable **)**
  673. .. container:: contribute
  674. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  675. .. rst-class:: classref-item-separator
  676. ----
  677. .. _class_Physics2DServer_method_area_set_param:
  678. .. rst-class:: classref-method
  679. void **area_set_param** **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` param, :ref:`Variant<class_Variant>` value **)**
  680. Sets the value for an area parameter. See :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` for a list of available parameters.
  681. .. rst-class:: classref-item-separator
  682. ----
  683. .. _class_Physics2DServer_method_area_set_shape:
  684. .. rst-class:: classref-method
  685. void **area_set_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)**
  686. Substitutes a given area shape by another. The old shape is selected by its index, the new one by its :ref:`RID<class_RID>`.
  687. .. rst-class:: classref-item-separator
  688. ----
  689. .. _class_Physics2DServer_method_area_set_shape_disabled:
  690. .. rst-class:: classref-method
  691. void **area_set_shape_disabled** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)**
  692. Disables a given shape in an area.
  693. .. rst-class:: classref-item-separator
  694. ----
  695. .. _class_Physics2DServer_method_area_set_shape_transform:
  696. .. rst-class:: classref-method
  697. void **area_set_shape_transform** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_Transform2D>` transform **)**
  698. Sets the transform matrix for an area shape.
  699. .. rst-class:: classref-item-separator
  700. ----
  701. .. _class_Physics2DServer_method_area_set_space:
  702. .. rst-class:: classref-method
  703. void **area_set_space** **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` space **)**
  704. Assigns a space to the area.
  705. .. rst-class:: classref-item-separator
  706. ----
  707. .. _class_Physics2DServer_method_area_set_space_override_mode:
  708. .. rst-class:: classref-method
  709. void **area_set_space_override_mode** **(** :ref:`RID<class_RID>` area, :ref:`AreaSpaceOverrideMode<enum_Physics2DServer_AreaSpaceOverrideMode>` mode **)**
  710. Sets the space override mode for the area. See :ref:`AreaSpaceOverrideMode<enum_Physics2DServer_AreaSpaceOverrideMode>` for a list of available modes.
  711. .. rst-class:: classref-item-separator
  712. ----
  713. .. _class_Physics2DServer_method_area_set_transform:
  714. .. rst-class:: classref-method
  715. void **area_set_transform** **(** :ref:`RID<class_RID>` area, :ref:`Transform2D<class_Transform2D>` transform **)**
  716. Sets the transform matrix for an area.
  717. .. rst-class:: classref-item-separator
  718. ----
  719. .. _class_Physics2DServer_method_body_add_central_force:
  720. .. rst-class:: classref-method
  721. void **body_add_central_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)**
  722. .. container:: contribute
  723. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  724. .. rst-class:: classref-item-separator
  725. ----
  726. .. _class_Physics2DServer_method_body_add_collision_exception:
  727. .. rst-class:: classref-method
  728. void **body_add_collision_exception** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)**
  729. Adds a body to the list of bodies exempt from collisions.
  730. .. rst-class:: classref-item-separator
  731. ----
  732. .. _class_Physics2DServer_method_body_add_force:
  733. .. rst-class:: classref-method
  734. void **body_add_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` offset, :ref:`Vector2<class_Vector2>` force **)**
  735. 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.
  736. .. rst-class:: classref-item-separator
  737. ----
  738. .. _class_Physics2DServer_method_body_add_shape:
  739. .. rst-class:: classref-method
  740. 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 **)**
  741. 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.
  742. .. rst-class:: classref-item-separator
  743. ----
  744. .. _class_Physics2DServer_method_body_add_torque:
  745. .. rst-class:: classref-method
  746. void **body_add_torque** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)**
  747. .. container:: contribute
  748. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  749. .. rst-class:: classref-item-separator
  750. ----
  751. .. _class_Physics2DServer_method_body_apply_central_impulse:
  752. .. rst-class:: classref-method
  753. void **body_apply_central_impulse** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` impulse **)**
  754. .. container:: contribute
  755. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  756. .. rst-class:: classref-item-separator
  757. ----
  758. .. _class_Physics2DServer_method_body_apply_impulse:
  759. .. rst-class:: classref-method
  760. void **body_apply_impulse** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` position, :ref:`Vector2<class_Vector2>` impulse **)**
  761. Adds a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates.
  762. .. rst-class:: classref-item-separator
  763. ----
  764. .. _class_Physics2DServer_method_body_apply_torque_impulse:
  765. .. rst-class:: classref-method
  766. void **body_apply_torque_impulse** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` impulse **)**
  767. .. container:: contribute
  768. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  769. .. rst-class:: classref-item-separator
  770. ----
  771. .. _class_Physics2DServer_method_body_attach_canvas_instance_id:
  772. .. rst-class:: classref-method
  773. void **body_attach_canvas_instance_id** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)**
  774. .. container:: contribute
  775. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  776. .. rst-class:: classref-item-separator
  777. ----
  778. .. _class_Physics2DServer_method_body_attach_object_instance_id:
  779. .. rst-class:: classref-method
  780. void **body_attach_object_instance_id** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)**
  781. Assigns the area to a descendant of :ref:`Object<class_Object>`, so it can exist in the node tree.
  782. .. rst-class:: classref-item-separator
  783. ----
  784. .. _class_Physics2DServer_method_body_clear_shapes:
  785. .. rst-class:: classref-method
  786. void **body_clear_shapes** **(** :ref:`RID<class_RID>` body **)**
  787. Removes all shapes from a body.
  788. .. rst-class:: classref-item-separator
  789. ----
  790. .. _class_Physics2DServer_method_body_create:
  791. .. rst-class:: classref-method
  792. :ref:`RID<class_RID>` **body_create** **(** **)**
  793. Creates a physics body.
  794. .. rst-class:: classref-item-separator
  795. ----
  796. .. _class_Physics2DServer_method_body_get_canvas_instance_id:
  797. .. rst-class:: classref-method
  798. :ref:`int<class_int>` **body_get_canvas_instance_id** **(** :ref:`RID<class_RID>` body **)** |const|
  799. .. container:: contribute
  800. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  801. .. rst-class:: classref-item-separator
  802. ----
  803. .. _class_Physics2DServer_method_body_get_collision_layer:
  804. .. rst-class:: classref-method
  805. :ref:`int<class_int>` **body_get_collision_layer** **(** :ref:`RID<class_RID>` body **)** |const|
  806. Returns the physics layer or layers a body belongs to.
  807. .. rst-class:: classref-item-separator
  808. ----
  809. .. _class_Physics2DServer_method_body_get_collision_mask:
  810. .. rst-class:: classref-method
  811. :ref:`int<class_int>` **body_get_collision_mask** **(** :ref:`RID<class_RID>` body **)** |const|
  812. Returns the physics layer or layers a body can collide with.
  813. .. rst-class:: classref-item-separator
  814. ----
  815. .. _class_Physics2DServer_method_body_get_continuous_collision_detection_mode:
  816. .. rst-class:: classref-method
  817. :ref:`CCDMode<enum_Physics2DServer_CCDMode>` **body_get_continuous_collision_detection_mode** **(** :ref:`RID<class_RID>` body **)** |const|
  818. Returns the continuous collision detection mode.
  819. .. rst-class:: classref-item-separator
  820. ----
  821. .. _class_Physics2DServer_method_body_get_direct_state:
  822. .. rst-class:: classref-method
  823. :ref:`Physics2DDirectBodyState<class_Physics2DDirectBodyState>` **body_get_direct_state** **(** :ref:`RID<class_RID>` body **)**
  824. Returns the :ref:`Physics2DDirectBodyState<class_Physics2DDirectBodyState>` of the body. Returns ``null`` if the body is destroyed or removed from the physics space.
  825. .. rst-class:: classref-item-separator
  826. ----
  827. .. _class_Physics2DServer_method_body_get_max_contacts_reported:
  828. .. rst-class:: classref-method
  829. :ref:`int<class_int>` **body_get_max_contacts_reported** **(** :ref:`RID<class_RID>` body **)** |const|
  830. Returns the maximum contacts that can be reported. See :ref:`body_set_max_contacts_reported<class_Physics2DServer_method_body_set_max_contacts_reported>`.
  831. .. rst-class:: classref-item-separator
  832. ----
  833. .. _class_Physics2DServer_method_body_get_mode:
  834. .. rst-class:: classref-method
  835. :ref:`BodyMode<enum_Physics2DServer_BodyMode>` **body_get_mode** **(** :ref:`RID<class_RID>` body **)** |const|
  836. Returns the body mode.
  837. .. rst-class:: classref-item-separator
  838. ----
  839. .. _class_Physics2DServer_method_body_get_object_instance_id:
  840. .. rst-class:: classref-method
  841. :ref:`int<class_int>` **body_get_object_instance_id** **(** :ref:`RID<class_RID>` body **)** |const|
  842. Gets the instance ID of the object the area is assigned to.
  843. .. rst-class:: classref-item-separator
  844. ----
  845. .. _class_Physics2DServer_method_body_get_param:
  846. .. rst-class:: classref-method
  847. :ref:`float<class_float>` **body_get_param** **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` param **)** |const|
  848. Returns the value of a body parameter. See :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` for a list of available parameters.
  849. .. rst-class:: classref-item-separator
  850. ----
  851. .. _class_Physics2DServer_method_body_get_shape:
  852. .. rst-class:: classref-method
  853. :ref:`RID<class_RID>` **body_get_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |const|
  854. Returns the :ref:`RID<class_RID>` of the nth shape of a body.
  855. .. rst-class:: classref-item-separator
  856. ----
  857. .. _class_Physics2DServer_method_body_get_shape_count:
  858. .. rst-class:: classref-method
  859. :ref:`int<class_int>` **body_get_shape_count** **(** :ref:`RID<class_RID>` body **)** |const|
  860. Returns the number of shapes assigned to a body.
  861. .. rst-class:: classref-item-separator
  862. ----
  863. .. _class_Physics2DServer_method_body_get_shape_metadata:
  864. .. rst-class:: classref-method
  865. :ref:`Variant<class_Variant>` **body_get_shape_metadata** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |const|
  866. Returns the metadata of a shape of a body.
  867. .. rst-class:: classref-item-separator
  868. ----
  869. .. _class_Physics2DServer_method_body_get_shape_transform:
  870. .. rst-class:: classref-method
  871. :ref:`Transform2D<class_Transform2D>` **body_get_shape_transform** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |const|
  872. Returns the transform matrix of a body shape.
  873. .. rst-class:: classref-item-separator
  874. ----
  875. .. _class_Physics2DServer_method_body_get_space:
  876. .. rst-class:: classref-method
  877. :ref:`RID<class_RID>` **body_get_space** **(** :ref:`RID<class_RID>` body **)** |const|
  878. Returns the :ref:`RID<class_RID>` of the space assigned to a body.
  879. .. rst-class:: classref-item-separator
  880. ----
  881. .. _class_Physics2DServer_method_body_get_state:
  882. .. rst-class:: classref-method
  883. :ref:`Variant<class_Variant>` **body_get_state** **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_Physics2DServer_BodyState>` state **)** |const|
  884. Returns a body state.
  885. .. rst-class:: classref-item-separator
  886. ----
  887. .. _class_Physics2DServer_method_body_is_omitting_force_integration:
  888. .. rst-class:: classref-method
  889. :ref:`bool<class_bool>` **body_is_omitting_force_integration** **(** :ref:`RID<class_RID>` body **)** |const|
  890. 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>`).
  891. .. rst-class:: classref-item-separator
  892. ----
  893. .. _class_Physics2DServer_method_body_remove_collision_exception:
  894. .. rst-class:: classref-method
  895. void **body_remove_collision_exception** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)**
  896. Removes a body from the list of bodies exempt from collisions.
  897. .. rst-class:: classref-item-separator
  898. ----
  899. .. _class_Physics2DServer_method_body_remove_shape:
  900. .. rst-class:: classref-method
  901. void **body_remove_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)**
  902. Removes a shape from a body. The shape is not deleted, so it can be reused afterwards.
  903. .. rst-class:: classref-item-separator
  904. ----
  905. .. _class_Physics2DServer_method_body_set_axis_velocity:
  906. .. rst-class:: classref-method
  907. void **body_set_axis_velocity** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` axis_velocity **)**
  908. 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.
  909. .. rst-class:: classref-item-separator
  910. ----
  911. .. _class_Physics2DServer_method_body_set_collision_layer:
  912. .. rst-class:: classref-method
  913. void **body_set_collision_layer** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` layer **)**
  914. Sets the physics layer or layers a body belongs to.
  915. .. rst-class:: classref-item-separator
  916. ----
  917. .. _class_Physics2DServer_method_body_set_collision_mask:
  918. .. rst-class:: classref-method
  919. void **body_set_collision_mask** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` mask **)**
  920. Sets the physics layer or layers a body can collide with.
  921. .. rst-class:: classref-item-separator
  922. ----
  923. .. _class_Physics2DServer_method_body_set_continuous_collision_detection_mode:
  924. .. rst-class:: classref-method
  925. void **body_set_continuous_collision_detection_mode** **(** :ref:`RID<class_RID>` body, :ref:`CCDMode<enum_Physics2DServer_CCDMode>` mode **)**
  926. Sets the continuous collision detection mode using one of the :ref:`CCDMode<enum_Physics2DServer_CCDMode>` constants.
  927. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
  928. .. rst-class:: classref-item-separator
  929. ----
  930. .. _class_Physics2DServer_method_body_set_force_integration_callback:
  931. .. rst-class:: classref-method
  932. void **body_set_force_integration_callback** **(** :ref:`RID<class_RID>` body, :ref:`Object<class_Object>` receiver, :ref:`String<class_String>` method, :ref:`Variant<class_Variant>` userdata=null **)**
  933. 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>`).
  934. .. rst-class:: classref-item-separator
  935. ----
  936. .. _class_Physics2DServer_method_body_set_max_contacts_reported:
  937. .. rst-class:: classref-method
  938. void **body_set_max_contacts_reported** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` amount **)**
  939. 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.
  940. .. rst-class:: classref-item-separator
  941. ----
  942. .. _class_Physics2DServer_method_body_set_mode:
  943. .. rst-class:: classref-method
  944. void **body_set_mode** **(** :ref:`RID<class_RID>` body, :ref:`BodyMode<enum_Physics2DServer_BodyMode>` mode **)**
  945. Sets the body mode using one of the :ref:`BodyMode<enum_Physics2DServer_BodyMode>` constants.
  946. .. rst-class:: classref-item-separator
  947. ----
  948. .. _class_Physics2DServer_method_body_set_omit_force_integration:
  949. .. rst-class:: classref-method
  950. void **body_set_omit_force_integration** **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)**
  951. 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>`).
  952. .. rst-class:: classref-item-separator
  953. ----
  954. .. _class_Physics2DServer_method_body_set_param:
  955. .. rst-class:: classref-method
  956. void **body_set_param** **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` param, :ref:`float<class_float>` value **)**
  957. Sets a body parameter. See :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` for a list of available parameters.
  958. .. rst-class:: classref-item-separator
  959. ----
  960. .. _class_Physics2DServer_method_body_set_shape:
  961. .. rst-class:: classref-method
  962. void **body_set_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)**
  963. Substitutes a given body shape by another. The old shape is selected by its index, the new one by its :ref:`RID<class_RID>`.
  964. .. rst-class:: classref-item-separator
  965. ----
  966. .. _class_Physics2DServer_method_body_set_shape_as_one_way_collision:
  967. .. rst-class:: classref-method
  968. 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 **)**
  969. Enables one way collision on body if ``enable`` is ``true``.
  970. .. rst-class:: classref-item-separator
  971. ----
  972. .. _class_Physics2DServer_method_body_set_shape_disabled:
  973. .. rst-class:: classref-method
  974. void **body_set_shape_disabled** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)**
  975. Disables shape in body if ``disable`` is ``true``.
  976. .. rst-class:: classref-item-separator
  977. ----
  978. .. _class_Physics2DServer_method_body_set_shape_metadata:
  979. .. rst-class:: classref-method
  980. void **body_set_shape_metadata** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`Variant<class_Variant>` metadata **)**
  981. 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.
  982. .. rst-class:: classref-item-separator
  983. ----
  984. .. _class_Physics2DServer_method_body_set_shape_transform:
  985. .. rst-class:: classref-method
  986. void **body_set_shape_transform** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_Transform2D>` transform **)**
  987. Sets the transform matrix for a body shape.
  988. .. rst-class:: classref-item-separator
  989. ----
  990. .. _class_Physics2DServer_method_body_set_space:
  991. .. rst-class:: classref-method
  992. void **body_set_space** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` space **)**
  993. Assigns a space to the body (see :ref:`space_create<class_Physics2DServer_method_space_create>`).
  994. .. rst-class:: classref-item-separator
  995. ----
  996. .. _class_Physics2DServer_method_body_set_state:
  997. .. rst-class:: classref-method
  998. void **body_set_state** **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_Physics2DServer_BodyState>` state, :ref:`Variant<class_Variant>` value **)**
  999. Sets a body state using one of the :ref:`BodyState<enum_Physics2DServer_BodyState>` constants.
  1000. Note that the method doesn't take effect immediately. The state will change on the next physics frame.
  1001. .. rst-class:: classref-item-separator
  1002. ----
  1003. .. _class_Physics2DServer_method_body_test_motion:
  1004. .. rst-class:: classref-method
  1005. :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, :ref:`bool<class_bool>` exclude_raycast_shapes=true, :ref:`Array<class_Array>` exclude=[ ] **)**
  1006. 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.
  1007. .. rst-class:: classref-item-separator
  1008. ----
  1009. .. _class_Physics2DServer_method_capsule_shape_create:
  1010. .. rst-class:: classref-method
  1011. :ref:`RID<class_RID>` **capsule_shape_create** **(** **)**
  1012. .. container:: contribute
  1013. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1014. .. rst-class:: classref-item-separator
  1015. ----
  1016. .. _class_Physics2DServer_method_circle_shape_create:
  1017. .. rst-class:: classref-method
  1018. :ref:`RID<class_RID>` **circle_shape_create** **(** **)**
  1019. .. container:: contribute
  1020. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1021. .. rst-class:: classref-item-separator
  1022. ----
  1023. .. _class_Physics2DServer_method_concave_polygon_shape_create:
  1024. .. rst-class:: classref-method
  1025. :ref:`RID<class_RID>` **concave_polygon_shape_create** **(** **)**
  1026. .. container:: contribute
  1027. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1028. .. rst-class:: classref-item-separator
  1029. ----
  1030. .. _class_Physics2DServer_method_convex_polygon_shape_create:
  1031. .. rst-class:: classref-method
  1032. :ref:`RID<class_RID>` **convex_polygon_shape_create** **(** **)**
  1033. .. container:: contribute
  1034. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1035. .. rst-class:: classref-item-separator
  1036. ----
  1037. .. _class_Physics2DServer_method_damped_spring_joint_create:
  1038. .. rst-class:: classref-method
  1039. :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 **)**
  1040. Creates a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself.
  1041. .. rst-class:: classref-item-separator
  1042. ----
  1043. .. _class_Physics2DServer_method_damped_string_joint_get_param:
  1044. .. rst-class:: classref-method
  1045. :ref:`float<class_float>` **damped_string_joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`DampedStringParam<enum_Physics2DServer_DampedStringParam>` param **)** |const|
  1046. Returns the value of a damped spring joint parameter.
  1047. .. rst-class:: classref-item-separator
  1048. ----
  1049. .. _class_Physics2DServer_method_damped_string_joint_set_param:
  1050. .. rst-class:: classref-method
  1051. void **damped_string_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`DampedStringParam<enum_Physics2DServer_DampedStringParam>` param, :ref:`float<class_float>` value **)**
  1052. Sets a damped spring joint parameter. See :ref:`DampedStringParam<enum_Physics2DServer_DampedStringParam>` for a list of available parameters.
  1053. .. rst-class:: classref-item-separator
  1054. ----
  1055. .. _class_Physics2DServer_method_free_rid:
  1056. .. rst-class:: classref-method
  1057. void **free_rid** **(** :ref:`RID<class_RID>` rid **)**
  1058. Destroys an object created by the Physics2DServer.
  1059. \ **Note:** See :ref:`VisualServer.free_rid<class_VisualServer_method_free_rid>` for details on how to handle RIDs for freed objects.
  1060. .. rst-class:: classref-item-separator
  1061. ----
  1062. .. _class_Physics2DServer_method_get_process_info:
  1063. .. rst-class:: classref-method
  1064. :ref:`int<class_int>` **get_process_info** **(** :ref:`ProcessInfo<enum_Physics2DServer_ProcessInfo>` process_info **)**
  1065. Returns information about the current state of the 2D physics engine. See :ref:`ProcessInfo<enum_Physics2DServer_ProcessInfo>` for a list of available states.
  1066. .. rst-class:: classref-item-separator
  1067. ----
  1068. .. _class_Physics2DServer_method_groove_joint_create:
  1069. .. rst-class:: classref-method
  1070. :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 **)**
  1071. Creates a groove joint between two bodies. If not specified, the bodies are assumed to be the joint itself.
  1072. .. rst-class:: classref-item-separator
  1073. ----
  1074. .. _class_Physics2DServer_method_joint_get_param:
  1075. .. rst-class:: classref-method
  1076. :ref:`float<class_float>` **joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_Physics2DServer_JointParam>` param **)** |const|
  1077. Returns the value of a joint parameter.
  1078. .. rst-class:: classref-item-separator
  1079. ----
  1080. .. _class_Physics2DServer_method_joint_get_type:
  1081. .. rst-class:: classref-method
  1082. :ref:`JointType<enum_Physics2DServer_JointType>` **joint_get_type** **(** :ref:`RID<class_RID>` joint **)** |const|
  1083. Returns a joint's type (see :ref:`JointType<enum_Physics2DServer_JointType>`).
  1084. .. rst-class:: classref-item-separator
  1085. ----
  1086. .. _class_Physics2DServer_method_joint_set_param:
  1087. .. rst-class:: classref-method
  1088. void **joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_Physics2DServer_JointParam>` param, :ref:`float<class_float>` value **)**
  1089. Sets a joint parameter. See :ref:`JointParam<enum_Physics2DServer_JointParam>` for a list of available parameters.
  1090. .. rst-class:: classref-item-separator
  1091. ----
  1092. .. _class_Physics2DServer_method_line_shape_create:
  1093. .. rst-class:: classref-method
  1094. :ref:`RID<class_RID>` **line_shape_create** **(** **)**
  1095. .. container:: contribute
  1096. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1097. .. rst-class:: classref-item-separator
  1098. ----
  1099. .. _class_Physics2DServer_method_pin_joint_create:
  1100. .. rst-class:: classref-method
  1101. :ref:`RID<class_RID>` **pin_joint_create** **(** :ref:`Vector2<class_Vector2>` anchor, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)**
  1102. Creates a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself.
  1103. .. rst-class:: classref-item-separator
  1104. ----
  1105. .. _class_Physics2DServer_method_ray_shape_create:
  1106. .. rst-class:: classref-method
  1107. :ref:`RID<class_RID>` **ray_shape_create** **(** **)**
  1108. .. container:: contribute
  1109. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1110. .. rst-class:: classref-item-separator
  1111. ----
  1112. .. _class_Physics2DServer_method_rectangle_shape_create:
  1113. .. rst-class:: classref-method
  1114. :ref:`RID<class_RID>` **rectangle_shape_create** **(** **)**
  1115. .. container:: contribute
  1116. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1117. .. rst-class:: classref-item-separator
  1118. ----
  1119. .. _class_Physics2DServer_method_segment_shape_create:
  1120. .. rst-class:: classref-method
  1121. :ref:`RID<class_RID>` **segment_shape_create** **(** **)**
  1122. .. container:: contribute
  1123. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1124. .. rst-class:: classref-item-separator
  1125. ----
  1126. .. _class_Physics2DServer_method_set_active:
  1127. .. rst-class:: classref-method
  1128. void **set_active** **(** :ref:`bool<class_bool>` active **)**
  1129. Activates or deactivates the 2D physics engine.
  1130. .. rst-class:: classref-item-separator
  1131. ----
  1132. .. _class_Physics2DServer_method_set_collision_iterations:
  1133. .. rst-class:: classref-method
  1134. void **set_collision_iterations** **(** :ref:`int<class_int>` iterations **)**
  1135. Sets the amount of iterations for calculating velocities of colliding bodies. The greater the amount of iterations, the more accurate the collisions will be. However, a greater amount of iterations requires more CPU power, which can decrease performance. The default value is ``8``.
  1136. .. rst-class:: classref-item-separator
  1137. ----
  1138. .. _class_Physics2DServer_method_shape_get_data:
  1139. .. rst-class:: classref-method
  1140. :ref:`Variant<class_Variant>` **shape_get_data** **(** :ref:`RID<class_RID>` shape **)** |const|
  1141. Returns the shape data.
  1142. .. rst-class:: classref-item-separator
  1143. ----
  1144. .. _class_Physics2DServer_method_shape_get_type:
  1145. .. rst-class:: classref-method
  1146. :ref:`ShapeType<enum_Physics2DServer_ShapeType>` **shape_get_type** **(** :ref:`RID<class_RID>` shape **)** |const|
  1147. Returns a shape's type (see :ref:`ShapeType<enum_Physics2DServer_ShapeType>`).
  1148. .. rst-class:: classref-item-separator
  1149. ----
  1150. .. _class_Physics2DServer_method_shape_set_data:
  1151. .. rst-class:: classref-method
  1152. void **shape_set_data** **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_Variant>` data **)**
  1153. 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>`.
  1154. .. rst-class:: classref-item-separator
  1155. ----
  1156. .. _class_Physics2DServer_method_space_create:
  1157. .. rst-class:: classref-method
  1158. :ref:`RID<class_RID>` **space_create** **(** **)**
  1159. 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>`.
  1160. .. rst-class:: classref-item-separator
  1161. ----
  1162. .. _class_Physics2DServer_method_space_get_direct_state:
  1163. .. rst-class:: classref-method
  1164. :ref:`Physics2DDirectSpaceState<class_Physics2DDirectSpaceState>` **space_get_direct_state** **(** :ref:`RID<class_RID>` space **)**
  1165. Returns the state of a space, a :ref:`Physics2DDirectSpaceState<class_Physics2DDirectSpaceState>`. This object can be used to make collision/intersection queries.
  1166. .. rst-class:: classref-item-separator
  1167. ----
  1168. .. _class_Physics2DServer_method_space_get_param:
  1169. .. rst-class:: classref-method
  1170. :ref:`float<class_float>` **space_get_param** **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_Physics2DServer_SpaceParameter>` param **)** |const|
  1171. Returns the value of a space parameter.
  1172. .. rst-class:: classref-item-separator
  1173. ----
  1174. .. _class_Physics2DServer_method_space_is_active:
  1175. .. rst-class:: classref-method
  1176. :ref:`bool<class_bool>` **space_is_active** **(** :ref:`RID<class_RID>` space **)** |const|
  1177. Returns whether the space is active.
  1178. .. rst-class:: classref-item-separator
  1179. ----
  1180. .. _class_Physics2DServer_method_space_set_active:
  1181. .. rst-class:: classref-method
  1182. void **space_set_active** **(** :ref:`RID<class_RID>` space, :ref:`bool<class_bool>` active **)**
  1183. Marks a space as active. It will not have an effect, unless it is assigned to an area or body.
  1184. .. rst-class:: classref-item-separator
  1185. ----
  1186. .. _class_Physics2DServer_method_space_set_param:
  1187. .. rst-class:: classref-method
  1188. void **space_set_param** **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_Physics2DServer_SpaceParameter>` param, :ref:`float<class_float>` value **)**
  1189. Sets the value for a space parameter. See :ref:`SpaceParameter<enum_Physics2DServer_SpaceParameter>` for a list of available parameters.
  1190. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  1191. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  1192. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  1193. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`