class_physicsserver2d.rst 155 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer2D.xml.
  6. .. _class_PhysicsServer2D:
  7. PhysicsServer2D
  8. ===============
  9. **Inherits:** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`PhysicsServer2DExtension<class_PhysicsServer2DExtension>`
  11. Server interface for low-level 2D physics access.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. PhysicsServer2D 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.
  16. .. rst-class:: classref-reftable-group
  17. Methods
  18. -------
  19. .. table::
  20. :widths: auto
  21. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`area_add_shape<class_PhysicsServer2D_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 **)** |
  23. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`area_attach_canvas_instance_id<class_PhysicsServer2D_method_area_attach_canvas_instance_id>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)** |
  25. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | void | :ref:`area_attach_object_instance_id<class_PhysicsServer2D_method_area_attach_object_instance_id>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)** |
  27. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | void | :ref:`area_clear_shapes<class_PhysicsServer2D_method_area_clear_shapes>` **(** :ref:`RID<class_RID>` area **)** |
  29. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | :ref:`RID<class_RID>` | :ref:`area_create<class_PhysicsServer2D_method_area_create>` **(** **)** |
  31. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | :ref:`int<class_int>` | :ref:`area_get_canvas_instance_id<class_PhysicsServer2D_method_area_get_canvas_instance_id>` **(** :ref:`RID<class_RID>` area **)** |const| |
  33. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  34. | :ref:`int<class_int>` | :ref:`area_get_collision_layer<class_PhysicsServer2D_method_area_get_collision_layer>` **(** :ref:`RID<class_RID>` area **)** |const| |
  35. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  36. | :ref:`int<class_int>` | :ref:`area_get_collision_mask<class_PhysicsServer2D_method_area_get_collision_mask>` **(** :ref:`RID<class_RID>` area **)** |const| |
  37. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  38. | :ref:`int<class_int>` | :ref:`area_get_object_instance_id<class_PhysicsServer2D_method_area_get_object_instance_id>` **(** :ref:`RID<class_RID>` area **)** |const| |
  39. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  40. | :ref:`Variant<class_Variant>` | :ref:`area_get_param<class_PhysicsServer2D_method_area_get_param>` **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` param **)** |const| |
  41. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | :ref:`RID<class_RID>` | :ref:`area_get_shape<class_PhysicsServer2D_method_area_get_shape>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |const| |
  43. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | :ref:`int<class_int>` | :ref:`area_get_shape_count<class_PhysicsServer2D_method_area_get_shape_count>` **(** :ref:`RID<class_RID>` area **)** |const| |
  45. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46. | :ref:`Transform2D<class_Transform2D>` | :ref:`area_get_shape_transform<class_PhysicsServer2D_method_area_get_shape_transform>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |const| |
  47. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48. | :ref:`RID<class_RID>` | :ref:`area_get_space<class_PhysicsServer2D_method_area_get_space>` **(** :ref:`RID<class_RID>` area **)** |const| |
  49. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50. | :ref:`Transform2D<class_Transform2D>` | :ref:`area_get_transform<class_PhysicsServer2D_method_area_get_transform>` **(** :ref:`RID<class_RID>` area **)** |const| |
  51. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52. | void | :ref:`area_remove_shape<class_PhysicsServer2D_method_area_remove_shape>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |
  53. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  54. | void | :ref:`area_set_area_monitor_callback<class_PhysicsServer2D_method_area_set_area_monitor_callback>` **(** :ref:`RID<class_RID>` area, :ref:`Callable<class_Callable>` callback **)** |
  55. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  56. | void | :ref:`area_set_collision_layer<class_PhysicsServer2D_method_area_set_collision_layer>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` layer **)** |
  57. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58. | void | :ref:`area_set_collision_mask<class_PhysicsServer2D_method_area_set_collision_mask>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` mask **)** |
  59. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  60. | void | :ref:`area_set_monitor_callback<class_PhysicsServer2D_method_area_set_monitor_callback>` **(** :ref:`RID<class_RID>` area, :ref:`Callable<class_Callable>` callback **)** |
  61. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62. | void | :ref:`area_set_monitorable<class_PhysicsServer2D_method_area_set_monitorable>` **(** :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` monitorable **)** |
  63. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64. | void | :ref:`area_set_param<class_PhysicsServer2D_method_area_set_param>` **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` param, :ref:`Variant<class_Variant>` value **)** |
  65. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66. | void | :ref:`area_set_shape<class_PhysicsServer2D_method_area_set_shape>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)** |
  67. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68. | void | :ref:`area_set_shape_disabled<class_PhysicsServer2D_method_area_set_shape_disabled>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)** |
  69. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | void | :ref:`area_set_shape_transform<class_PhysicsServer2D_method_area_set_shape_transform>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_Transform2D>` transform **)** |
  71. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | void | :ref:`area_set_space<class_PhysicsServer2D_method_area_set_space>` **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` space **)** |
  73. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | void | :ref:`area_set_transform<class_PhysicsServer2D_method_area_set_transform>` **(** :ref:`RID<class_RID>` area, :ref:`Transform2D<class_Transform2D>` transform **)** |
  75. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | void | :ref:`body_add_collision_exception<class_PhysicsServer2D_method_body_add_collision_exception>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)** |
  77. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | void | :ref:`body_add_constant_central_force<class_PhysicsServer2D_method_body_add_constant_central_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)** |
  79. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80. | void | :ref:`body_add_constant_force<class_PhysicsServer2D_method_body_add_constant_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force, :ref:`Vector2<class_Vector2>` position=Vector2(0, 0) **)** |
  81. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82. | void | :ref:`body_add_constant_torque<class_PhysicsServer2D_method_body_add_constant_torque>` **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)** |
  83. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | void | :ref:`body_add_shape<class_PhysicsServer2D_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 **)** |
  85. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | void | :ref:`body_apply_central_force<class_PhysicsServer2D_method_body_apply_central_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)** |
  87. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | void | :ref:`body_apply_central_impulse<class_PhysicsServer2D_method_body_apply_central_impulse>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` impulse **)** |
  89. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | void | :ref:`body_apply_force<class_PhysicsServer2D_method_body_apply_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force, :ref:`Vector2<class_Vector2>` position=Vector2(0, 0) **)** |
  91. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | void | :ref:`body_apply_impulse<class_PhysicsServer2D_method_body_apply_impulse>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` impulse, :ref:`Vector2<class_Vector2>` position=Vector2(0, 0) **)** |
  93. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | void | :ref:`body_apply_torque<class_PhysicsServer2D_method_body_apply_torque>` **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)** |
  95. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | void | :ref:`body_apply_torque_impulse<class_PhysicsServer2D_method_body_apply_torque_impulse>` **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` impulse **)** |
  97. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | void | :ref:`body_attach_canvas_instance_id<class_PhysicsServer2D_method_body_attach_canvas_instance_id>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)** |
  99. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  100. | void | :ref:`body_attach_object_instance_id<class_PhysicsServer2D_method_body_attach_object_instance_id>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)** |
  101. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  102. | void | :ref:`body_clear_shapes<class_PhysicsServer2D_method_body_clear_shapes>` **(** :ref:`RID<class_RID>` body **)** |
  103. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  104. | :ref:`RID<class_RID>` | :ref:`body_create<class_PhysicsServer2D_method_body_create>` **(** **)** |
  105. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  106. | :ref:`int<class_int>` | :ref:`body_get_canvas_instance_id<class_PhysicsServer2D_method_body_get_canvas_instance_id>` **(** :ref:`RID<class_RID>` body **)** |const| |
  107. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  108. | :ref:`int<class_int>` | :ref:`body_get_collision_layer<class_PhysicsServer2D_method_body_get_collision_layer>` **(** :ref:`RID<class_RID>` body **)** |const| |
  109. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  110. | :ref:`int<class_int>` | :ref:`body_get_collision_mask<class_PhysicsServer2D_method_body_get_collision_mask>` **(** :ref:`RID<class_RID>` body **)** |const| |
  111. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  112. | :ref:`float<class_float>` | :ref:`body_get_collision_priority<class_PhysicsServer2D_method_body_get_collision_priority>` **(** :ref:`RID<class_RID>` body **)** |const| |
  113. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  114. | :ref:`Vector2<class_Vector2>` | :ref:`body_get_constant_force<class_PhysicsServer2D_method_body_get_constant_force>` **(** :ref:`RID<class_RID>` body **)** |const| |
  115. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  116. | :ref:`float<class_float>` | :ref:`body_get_constant_torque<class_PhysicsServer2D_method_body_get_constant_torque>` **(** :ref:`RID<class_RID>` body **)** |const| |
  117. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  118. | :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` | :ref:`body_get_continuous_collision_detection_mode<class_PhysicsServer2D_method_body_get_continuous_collision_detection_mode>` **(** :ref:`RID<class_RID>` body **)** |const| |
  119. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  120. | :ref:`PhysicsDirectBodyState2D<class_PhysicsDirectBodyState2D>` | :ref:`body_get_direct_state<class_PhysicsServer2D_method_body_get_direct_state>` **(** :ref:`RID<class_RID>` body **)** |
  121. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  122. | :ref:`int<class_int>` | :ref:`body_get_max_contacts_reported<class_PhysicsServer2D_method_body_get_max_contacts_reported>` **(** :ref:`RID<class_RID>` body **)** |const| |
  123. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  124. | :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` | :ref:`body_get_mode<class_PhysicsServer2D_method_body_get_mode>` **(** :ref:`RID<class_RID>` body **)** |const| |
  125. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  126. | :ref:`int<class_int>` | :ref:`body_get_object_instance_id<class_PhysicsServer2D_method_body_get_object_instance_id>` **(** :ref:`RID<class_RID>` body **)** |const| |
  127. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  128. | :ref:`Variant<class_Variant>` | :ref:`body_get_param<class_PhysicsServer2D_method_body_get_param>` **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` param **)** |const| |
  129. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  130. | :ref:`RID<class_RID>` | :ref:`body_get_shape<class_PhysicsServer2D_method_body_get_shape>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |const| |
  131. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  132. | :ref:`int<class_int>` | :ref:`body_get_shape_count<class_PhysicsServer2D_method_body_get_shape_count>` **(** :ref:`RID<class_RID>` body **)** |const| |
  133. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  134. | :ref:`Transform2D<class_Transform2D>` | :ref:`body_get_shape_transform<class_PhysicsServer2D_method_body_get_shape_transform>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |const| |
  135. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  136. | :ref:`RID<class_RID>` | :ref:`body_get_space<class_PhysicsServer2D_method_body_get_space>` **(** :ref:`RID<class_RID>` body **)** |const| |
  137. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  138. | :ref:`Variant<class_Variant>` | :ref:`body_get_state<class_PhysicsServer2D_method_body_get_state>` **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_PhysicsServer2D_BodyState>` state **)** |const| |
  139. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  140. | :ref:`bool<class_bool>` | :ref:`body_is_omitting_force_integration<class_PhysicsServer2D_method_body_is_omitting_force_integration>` **(** :ref:`RID<class_RID>` body **)** |const| |
  141. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  142. | void | :ref:`body_remove_collision_exception<class_PhysicsServer2D_method_body_remove_collision_exception>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)** |
  143. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  144. | void | :ref:`body_remove_shape<class_PhysicsServer2D_method_body_remove_shape>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |
  145. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  146. | void | :ref:`body_reset_mass_properties<class_PhysicsServer2D_method_body_reset_mass_properties>` **(** :ref:`RID<class_RID>` body **)** |
  147. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  148. | void | :ref:`body_set_axis_velocity<class_PhysicsServer2D_method_body_set_axis_velocity>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` axis_velocity **)** |
  149. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  150. | void | :ref:`body_set_collision_layer<class_PhysicsServer2D_method_body_set_collision_layer>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` layer **)** |
  151. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  152. | void | :ref:`body_set_collision_mask<class_PhysicsServer2D_method_body_set_collision_mask>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` mask **)** |
  153. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  154. | void | :ref:`body_set_collision_priority<class_PhysicsServer2D_method_body_set_collision_priority>` **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` priority **)** |
  155. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  156. | void | :ref:`body_set_constant_force<class_PhysicsServer2D_method_body_set_constant_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)** |
  157. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  158. | void | :ref:`body_set_constant_torque<class_PhysicsServer2D_method_body_set_constant_torque>` **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)** |
  159. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  160. | void | :ref:`body_set_continuous_collision_detection_mode<class_PhysicsServer2D_method_body_set_continuous_collision_detection_mode>` **(** :ref:`RID<class_RID>` body, :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` mode **)** |
  161. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  162. | void | :ref:`body_set_force_integration_callback<class_PhysicsServer2D_method_body_set_force_integration_callback>` **(** :ref:`RID<class_RID>` body, :ref:`Callable<class_Callable>` callable, :ref:`Variant<class_Variant>` userdata=null **)** |
  163. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  164. | void | :ref:`body_set_max_contacts_reported<class_PhysicsServer2D_method_body_set_max_contacts_reported>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` amount **)** |
  165. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  166. | void | :ref:`body_set_mode<class_PhysicsServer2D_method_body_set_mode>` **(** :ref:`RID<class_RID>` body, :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` mode **)** |
  167. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  168. | void | :ref:`body_set_omit_force_integration<class_PhysicsServer2D_method_body_set_omit_force_integration>` **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)** |
  169. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  170. | void | :ref:`body_set_param<class_PhysicsServer2D_method_body_set_param>` **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` param, :ref:`Variant<class_Variant>` value **)** |
  171. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  172. | void | :ref:`body_set_shape<class_PhysicsServer2D_method_body_set_shape>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)** |
  173. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  174. | void | :ref:`body_set_shape_as_one_way_collision<class_PhysicsServer2D_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 **)** |
  175. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  176. | void | :ref:`body_set_shape_disabled<class_PhysicsServer2D_method_body_set_shape_disabled>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)** |
  177. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  178. | void | :ref:`body_set_shape_transform<class_PhysicsServer2D_method_body_set_shape_transform>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_Transform2D>` transform **)** |
  179. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  180. | void | :ref:`body_set_space<class_PhysicsServer2D_method_body_set_space>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` space **)** |
  181. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  182. | void | :ref:`body_set_state<class_PhysicsServer2D_method_body_set_state>` **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_PhysicsServer2D_BodyState>` state, :ref:`Variant<class_Variant>` value **)** |
  183. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  184. | :ref:`bool<class_bool>` | :ref:`body_test_motion<class_PhysicsServer2D_method_body_test_motion>` **(** :ref:`RID<class_RID>` body, :ref:`PhysicsTestMotionParameters2D<class_PhysicsTestMotionParameters2D>` parameters, :ref:`PhysicsTestMotionResult2D<class_PhysicsTestMotionResult2D>` result=null **)** |
  185. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  186. | :ref:`RID<class_RID>` | :ref:`capsule_shape_create<class_PhysicsServer2D_method_capsule_shape_create>` **(** **)** |
  187. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  188. | :ref:`RID<class_RID>` | :ref:`circle_shape_create<class_PhysicsServer2D_method_circle_shape_create>` **(** **)** |
  189. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  190. | :ref:`RID<class_RID>` | :ref:`concave_polygon_shape_create<class_PhysicsServer2D_method_concave_polygon_shape_create>` **(** **)** |
  191. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  192. | :ref:`RID<class_RID>` | :ref:`convex_polygon_shape_create<class_PhysicsServer2D_method_convex_polygon_shape_create>` **(** **)** |
  193. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  194. | :ref:`float<class_float>` | :ref:`damped_spring_joint_get_param<class_PhysicsServer2D_method_damped_spring_joint_get_param>` **(** :ref:`RID<class_RID>` joint, :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` param **)** |const| |
  195. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  196. | void | :ref:`damped_spring_joint_set_param<class_PhysicsServer2D_method_damped_spring_joint_set_param>` **(** :ref:`RID<class_RID>` joint, :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` param, :ref:`float<class_float>` value **)** |
  197. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  198. | void | :ref:`free_rid<class_PhysicsServer2D_method_free_rid>` **(** :ref:`RID<class_RID>` rid **)** |
  199. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  200. | :ref:`int<class_int>` | :ref:`get_process_info<class_PhysicsServer2D_method_get_process_info>` **(** :ref:`ProcessInfo<enum_PhysicsServer2D_ProcessInfo>` process_info **)** |
  201. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  202. | void | :ref:`joint_clear<class_PhysicsServer2D_method_joint_clear>` **(** :ref:`RID<class_RID>` joint **)** |
  203. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  204. | :ref:`RID<class_RID>` | :ref:`joint_create<class_PhysicsServer2D_method_joint_create>` **(** **)** |
  205. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  206. | void | :ref:`joint_disable_collisions_between_bodies<class_PhysicsServer2D_method_joint_disable_collisions_between_bodies>` **(** :ref:`RID<class_RID>` joint, :ref:`bool<class_bool>` disable **)** |
  207. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  208. | :ref:`float<class_float>` | :ref:`joint_get_param<class_PhysicsServer2D_method_joint_get_param>` **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_PhysicsServer2D_JointParam>` param **)** |const| |
  209. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  210. | :ref:`JointType<enum_PhysicsServer2D_JointType>` | :ref:`joint_get_type<class_PhysicsServer2D_method_joint_get_type>` **(** :ref:`RID<class_RID>` joint **)** |const| |
  211. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  212. | :ref:`bool<class_bool>` | :ref:`joint_is_disabled_collisions_between_bodies<class_PhysicsServer2D_method_joint_is_disabled_collisions_between_bodies>` **(** :ref:`RID<class_RID>` joint **)** |const| |
  213. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  214. | void | :ref:`joint_make_damped_spring<class_PhysicsServer2D_method_joint_make_damped_spring>` **(** :ref:`RID<class_RID>` joint, :ref:`Vector2<class_Vector2>` anchor_a, :ref:`Vector2<class_Vector2>` anchor_b, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)** |
  215. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  216. | void | :ref:`joint_make_groove<class_PhysicsServer2D_method_joint_make_groove>` **(** :ref:`RID<class_RID>` joint, :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 **)** |
  217. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  218. | void | :ref:`joint_make_pin<class_PhysicsServer2D_method_joint_make_pin>` **(** :ref:`RID<class_RID>` joint, :ref:`Vector2<class_Vector2>` anchor, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)** |
  219. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  220. | void | :ref:`joint_set_param<class_PhysicsServer2D_method_joint_set_param>` **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_PhysicsServer2D_JointParam>` param, :ref:`float<class_float>` value **)** |
  221. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  222. | :ref:`float<class_float>` | :ref:`pin_joint_get_param<class_PhysicsServer2D_method_pin_joint_get_param>` **(** :ref:`RID<class_RID>` joint, :ref:`PinJointParam<enum_PhysicsServer2D_PinJointParam>` param **)** |const| |
  223. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  224. | void | :ref:`pin_joint_set_param<class_PhysicsServer2D_method_pin_joint_set_param>` **(** :ref:`RID<class_RID>` joint, :ref:`PinJointParam<enum_PhysicsServer2D_PinJointParam>` param, :ref:`float<class_float>` value **)** |
  225. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  226. | :ref:`RID<class_RID>` | :ref:`rectangle_shape_create<class_PhysicsServer2D_method_rectangle_shape_create>` **(** **)** |
  227. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  228. | :ref:`RID<class_RID>` | :ref:`segment_shape_create<class_PhysicsServer2D_method_segment_shape_create>` **(** **)** |
  229. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  230. | :ref:`RID<class_RID>` | :ref:`separation_ray_shape_create<class_PhysicsServer2D_method_separation_ray_shape_create>` **(** **)** |
  231. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  232. | void | :ref:`set_active<class_PhysicsServer2D_method_set_active>` **(** :ref:`bool<class_bool>` active **)** |
  233. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  234. | :ref:`Variant<class_Variant>` | :ref:`shape_get_data<class_PhysicsServer2D_method_shape_get_data>` **(** :ref:`RID<class_RID>` shape **)** |const| |
  235. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  236. | :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` | :ref:`shape_get_type<class_PhysicsServer2D_method_shape_get_type>` **(** :ref:`RID<class_RID>` shape **)** |const| |
  237. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  238. | void | :ref:`shape_set_data<class_PhysicsServer2D_method_shape_set_data>` **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_Variant>` data **)** |
  239. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  240. | :ref:`RID<class_RID>` | :ref:`space_create<class_PhysicsServer2D_method_space_create>` **(** **)** |
  241. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  242. | :ref:`PhysicsDirectSpaceState2D<class_PhysicsDirectSpaceState2D>` | :ref:`space_get_direct_state<class_PhysicsServer2D_method_space_get_direct_state>` **(** :ref:`RID<class_RID>` space **)** |
  243. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  244. | :ref:`float<class_float>` | :ref:`space_get_param<class_PhysicsServer2D_method_space_get_param>` **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` param **)** |const| |
  245. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  246. | :ref:`bool<class_bool>` | :ref:`space_is_active<class_PhysicsServer2D_method_space_is_active>` **(** :ref:`RID<class_RID>` space **)** |const| |
  247. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  248. | void | :ref:`space_set_active<class_PhysicsServer2D_method_space_set_active>` **(** :ref:`RID<class_RID>` space, :ref:`bool<class_bool>` active **)** |
  249. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  250. | void | :ref:`space_set_param<class_PhysicsServer2D_method_space_set_param>` **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` param, :ref:`float<class_float>` value **)** |
  251. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  252. | :ref:`RID<class_RID>` | :ref:`world_boundary_shape_create<class_PhysicsServer2D_method_world_boundary_shape_create>` **(** **)** |
  253. +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  254. .. rst-class:: classref-section-separator
  255. ----
  256. .. rst-class:: classref-descriptions-group
  257. Enumerations
  258. ------------
  259. .. _enum_PhysicsServer2D_SpaceParameter:
  260. .. rst-class:: classref-enumeration
  261. enum **SpaceParameter**:
  262. .. _class_PhysicsServer2D_constant_SPACE_PARAM_CONTACT_RECYCLE_RADIUS:
  263. .. rst-class:: classref-enumeration-constant
  264. :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` **SPACE_PARAM_CONTACT_RECYCLE_RADIUS** = ``0``
  265. Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated.
  266. .. _class_PhysicsServer2D_constant_SPACE_PARAM_CONTACT_MAX_SEPARATION:
  267. .. rst-class:: classref-enumeration-constant
  268. :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` **SPACE_PARAM_CONTACT_MAX_SEPARATION** = ``1``
  269. Constant to set/get the maximum distance a shape can be from another before they are considered separated and the contact is discarded.
  270. .. _class_PhysicsServer2D_constant_SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION:
  271. .. rst-class:: classref-enumeration-constant
  272. :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` **SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION** = ``2``
  273. Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision.
  274. .. _class_PhysicsServer2D_constant_SPACE_PARAM_CONTACT_DEFAULT_BIAS:
  275. .. rst-class:: classref-enumeration-constant
  276. :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` **SPACE_PARAM_CONTACT_DEFAULT_BIAS** = ``3``
  277. Constant to set/get the default solver bias for all physics contacts. A solver bias is a factor controlling how much two objects "rebound", after overlapping, to avoid leaving them in that state because of numerical imprecision.
  278. .. _class_PhysicsServer2D_constant_SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD:
  279. .. rst-class:: classref-enumeration-constant
  280. :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` **SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD** = ``4``
  281. 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.
  282. .. _class_PhysicsServer2D_constant_SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD:
  283. .. rst-class:: classref-enumeration-constant
  284. :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` **SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD** = ``5``
  285. 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.
  286. .. _class_PhysicsServer2D_constant_SPACE_PARAM_BODY_TIME_TO_SLEEP:
  287. .. rst-class:: classref-enumeration-constant
  288. :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` **SPACE_PARAM_BODY_TIME_TO_SLEEP** = ``6``
  289. 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.
  290. .. _class_PhysicsServer2D_constant_SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS:
  291. .. rst-class:: classref-enumeration-constant
  292. :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` **SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS** = ``7``
  293. 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.
  294. .. _class_PhysicsServer2D_constant_SPACE_PARAM_SOLVER_ITERATIONS:
  295. .. rst-class:: classref-enumeration-constant
  296. :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` **SPACE_PARAM_SOLVER_ITERATIONS** = ``8``
  297. Constant to set/get the number of solver iterations for all contacts and constraints. The greater the number of iterations, the more accurate the collisions will be. However, a greater number of iterations requires more CPU power, which can decrease performance.
  298. .. rst-class:: classref-item-separator
  299. ----
  300. .. _enum_PhysicsServer2D_ShapeType:
  301. .. rst-class:: classref-enumeration
  302. enum **ShapeType**:
  303. .. _class_PhysicsServer2D_constant_SHAPE_WORLD_BOUNDARY:
  304. .. rst-class:: classref-enumeration-constant
  305. :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **SHAPE_WORLD_BOUNDARY** = ``0``
  306. This is the constant for creating world boundary shapes. A world boundary shape is an *infinite* line with an origin point, and a normal. Thus, it can be used for front/behind checks.
  307. .. _class_PhysicsServer2D_constant_SHAPE_SEPARATION_RAY:
  308. .. rst-class:: classref-enumeration-constant
  309. :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **SHAPE_SEPARATION_RAY** = ``1``
  310. This is the constant for creating separation ray shapes. A separation ray is defined by a length and separates itself from what is touching its far endpoint. Useful for character controllers.
  311. .. _class_PhysicsServer2D_constant_SHAPE_SEGMENT:
  312. .. rst-class:: classref-enumeration-constant
  313. :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **SHAPE_SEGMENT** = ``2``
  314. This is the constant for creating segment shapes. A segment shape is a *finite* line from a point A to a point B. It can be checked for intersections.
  315. .. _class_PhysicsServer2D_constant_SHAPE_CIRCLE:
  316. .. rst-class:: classref-enumeration-constant
  317. :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **SHAPE_CIRCLE** = ``3``
  318. 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.
  319. .. _class_PhysicsServer2D_constant_SHAPE_RECTANGLE:
  320. .. rst-class:: classref-enumeration-constant
  321. :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **SHAPE_RECTANGLE** = ``4``
  322. 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.
  323. .. _class_PhysicsServer2D_constant_SHAPE_CAPSULE:
  324. .. rst-class:: classref-enumeration-constant
  325. :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **SHAPE_CAPSULE** = ``5``
  326. 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.
  327. .. _class_PhysicsServer2D_constant_SHAPE_CONVEX_POLYGON:
  328. .. rst-class:: classref-enumeration-constant
  329. :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **SHAPE_CONVEX_POLYGON** = ``6``
  330. 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_PhysicsServer2D_method_shape_set_data>` do not verify that the points supplied form is a convex polygon.
  331. .. _class_PhysicsServer2D_constant_SHAPE_CONCAVE_POLYGON:
  332. .. rst-class:: classref-enumeration-constant
  333. :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **SHAPE_CONCAVE_POLYGON** = ``7``
  334. 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.
  335. .. _class_PhysicsServer2D_constant_SHAPE_CUSTOM:
  336. .. rst-class:: classref-enumeration-constant
  337. :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **SHAPE_CUSTOM** = ``8``
  338. This constant is used internally by the engine. Any attempt to create this kind of shape results in an error.
  339. .. rst-class:: classref-item-separator
  340. ----
  341. .. _enum_PhysicsServer2D_AreaParameter:
  342. .. rst-class:: classref-enumeration
  343. enum **AreaParameter**:
  344. .. _class_PhysicsServer2D_constant_AREA_PARAM_GRAVITY_OVERRIDE_MODE:
  345. .. rst-class:: classref-enumeration-constant
  346. :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_GRAVITY_OVERRIDE_MODE** = ``0``
  347. Constant to set/get gravity override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` for possible values.
  348. .. _class_PhysicsServer2D_constant_AREA_PARAM_GRAVITY:
  349. .. rst-class:: classref-enumeration-constant
  350. :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_GRAVITY** = ``1``
  351. Constant to set/get gravity strength in an area.
  352. .. _class_PhysicsServer2D_constant_AREA_PARAM_GRAVITY_VECTOR:
  353. .. rst-class:: classref-enumeration-constant
  354. :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_GRAVITY_VECTOR** = ``2``
  355. Constant to set/get gravity vector/center in an area.
  356. .. _class_PhysicsServer2D_constant_AREA_PARAM_GRAVITY_IS_POINT:
  357. .. rst-class:: classref-enumeration-constant
  358. :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_GRAVITY_IS_POINT** = ``3``
  359. Constant to set/get whether the gravity vector of an area is a direction, or a center point.
  360. .. _class_PhysicsServer2D_constant_AREA_PARAM_GRAVITY_DISTANCE_SCALE:
  361. .. rst-class:: classref-enumeration-constant
  362. :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_GRAVITY_DISTANCE_SCALE** = ``4``
  363. 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.
  364. .. _class_PhysicsServer2D_constant_AREA_PARAM_GRAVITY_POINT_ATTENUATION:
  365. .. rst-class:: classref-enumeration-constant
  366. :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_GRAVITY_POINT_ATTENUATION** = ``5``
  367. 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_PhysicsServer2D_constant_AREA_PARAM_GRAVITY_DISTANCE_SCALE>`.
  368. .. _class_PhysicsServer2D_constant_AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE:
  369. .. rst-class:: classref-enumeration-constant
  370. :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE** = ``6``
  371. Constant to set/get linear damping override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` for possible values.
  372. .. _class_PhysicsServer2D_constant_AREA_PARAM_LINEAR_DAMP:
  373. .. rst-class:: classref-enumeration-constant
  374. :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_LINEAR_DAMP** = ``7``
  375. Constant to set/get the linear damping factor of an area.
  376. .. _class_PhysicsServer2D_constant_AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE:
  377. .. rst-class:: classref-enumeration-constant
  378. :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE** = ``8``
  379. Constant to set/get angular damping override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` for possible values.
  380. .. _class_PhysicsServer2D_constant_AREA_PARAM_ANGULAR_DAMP:
  381. .. rst-class:: classref-enumeration-constant
  382. :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_ANGULAR_DAMP** = ``9``
  383. Constant to set/get the angular damping factor of an area.
  384. .. _class_PhysicsServer2D_constant_AREA_PARAM_PRIORITY:
  385. .. rst-class:: classref-enumeration-constant
  386. :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_PRIORITY** = ``10``
  387. Constant to set/get the priority (order of processing) of an area.
  388. .. rst-class:: classref-item-separator
  389. ----
  390. .. _enum_PhysicsServer2D_AreaSpaceOverrideMode:
  391. .. rst-class:: classref-enumeration
  392. enum **AreaSpaceOverrideMode**:
  393. .. _class_PhysicsServer2D_constant_AREA_SPACE_OVERRIDE_DISABLED:
  394. .. rst-class:: classref-enumeration-constant
  395. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_DISABLED** = ``0``
  396. This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
  397. .. _class_PhysicsServer2D_constant_AREA_SPACE_OVERRIDE_COMBINE:
  398. .. rst-class:: classref-enumeration-constant
  399. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_COMBINE** = ``1``
  400. 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.
  401. .. _class_PhysicsServer2D_constant_AREA_SPACE_OVERRIDE_COMBINE_REPLACE:
  402. .. rst-class:: classref-enumeration-constant
  403. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_COMBINE_REPLACE** = ``2``
  404. 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.
  405. .. _class_PhysicsServer2D_constant_AREA_SPACE_OVERRIDE_REPLACE:
  406. .. rst-class:: classref-enumeration-constant
  407. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_REPLACE** = ``3``
  408. This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
  409. .. _class_PhysicsServer2D_constant_AREA_SPACE_OVERRIDE_REPLACE_COMBINE:
  410. .. rst-class:: classref-enumeration-constant
  411. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_REPLACE_COMBINE** = ``4``
  412. This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
  413. .. rst-class:: classref-item-separator
  414. ----
  415. .. _enum_PhysicsServer2D_BodyMode:
  416. .. rst-class:: classref-enumeration
  417. enum **BodyMode**:
  418. .. _class_PhysicsServer2D_constant_BODY_MODE_STATIC:
  419. .. rst-class:: classref-enumeration-constant
  420. :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` **BODY_MODE_STATIC** = ``0``
  421. Constant for static bodies. In this mode, a body can be only moved by user code and doesn't collide with other bodies along its path when moved.
  422. .. _class_PhysicsServer2D_constant_BODY_MODE_KINEMATIC:
  423. .. rst-class:: classref-enumeration-constant
  424. :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` **BODY_MODE_KINEMATIC** = ``1``
  425. Constant for kinematic bodies. In this mode, a body can be only moved by user code and collides with other bodies along its path.
  426. .. _class_PhysicsServer2D_constant_BODY_MODE_RIGID:
  427. .. rst-class:: classref-enumeration-constant
  428. :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` **BODY_MODE_RIGID** = ``2``
  429. Constant for rigid bodies. In this mode, a body can be pushed by other bodies and has forces applied.
  430. .. _class_PhysicsServer2D_constant_BODY_MODE_RIGID_LINEAR:
  431. .. rst-class:: classref-enumeration-constant
  432. :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` **BODY_MODE_RIGID_LINEAR** = ``3``
  433. Constant for linear rigid bodies. In this mode, a body can not rotate, and only its linear velocity is affected by external forces.
  434. .. rst-class:: classref-item-separator
  435. ----
  436. .. _enum_PhysicsServer2D_BodyParameter:
  437. .. rst-class:: classref-enumeration
  438. enum **BodyParameter**:
  439. .. _class_PhysicsServer2D_constant_BODY_PARAM_BOUNCE:
  440. .. rst-class:: classref-enumeration-constant
  441. :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_BOUNCE** = ``0``
  442. Constant to set/get a body's bounce factor.
  443. .. _class_PhysicsServer2D_constant_BODY_PARAM_FRICTION:
  444. .. rst-class:: classref-enumeration-constant
  445. :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_FRICTION** = ``1``
  446. Constant to set/get a body's friction.
  447. .. _class_PhysicsServer2D_constant_BODY_PARAM_MASS:
  448. .. rst-class:: classref-enumeration-constant
  449. :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_MASS** = ``2``
  450. Constant to set/get a body's mass.
  451. .. _class_PhysicsServer2D_constant_BODY_PARAM_INERTIA:
  452. .. rst-class:: classref-enumeration-constant
  453. :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_INERTIA** = ``3``
  454. Constant to set/get a body's inertia.
  455. .. _class_PhysicsServer2D_constant_BODY_PARAM_CENTER_OF_MASS:
  456. .. rst-class:: classref-enumeration-constant
  457. :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_CENTER_OF_MASS** = ``4``
  458. Constant to set/get a body's center of mass position in the body's local coordinate system.
  459. .. _class_PhysicsServer2D_constant_BODY_PARAM_GRAVITY_SCALE:
  460. .. rst-class:: classref-enumeration-constant
  461. :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_GRAVITY_SCALE** = ``5``
  462. Constant to set/get a body's gravity multiplier.
  463. .. _class_PhysicsServer2D_constant_BODY_PARAM_LINEAR_DAMP_MODE:
  464. .. rst-class:: classref-enumeration-constant
  465. :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_LINEAR_DAMP_MODE** = ``6``
  466. Constant to set/get a body's linear dampening mode. See :ref:`BodyDampMode<enum_PhysicsServer2D_BodyDampMode>` for possible values.
  467. .. _class_PhysicsServer2D_constant_BODY_PARAM_ANGULAR_DAMP_MODE:
  468. .. rst-class:: classref-enumeration-constant
  469. :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_ANGULAR_DAMP_MODE** = ``7``
  470. Constant to set/get a body's angular dampening mode. See :ref:`BodyDampMode<enum_PhysicsServer2D_BodyDampMode>` for possible values.
  471. .. _class_PhysicsServer2D_constant_BODY_PARAM_LINEAR_DAMP:
  472. .. rst-class:: classref-enumeration-constant
  473. :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_LINEAR_DAMP** = ``8``
  474. Constant to set/get a body's linear dampening factor.
  475. .. _class_PhysicsServer2D_constant_BODY_PARAM_ANGULAR_DAMP:
  476. .. rst-class:: classref-enumeration-constant
  477. :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_ANGULAR_DAMP** = ``9``
  478. Constant to set/get a body's angular dampening factor.
  479. .. _class_PhysicsServer2D_constant_BODY_PARAM_MAX:
  480. .. rst-class:: classref-enumeration-constant
  481. :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_MAX** = ``10``
  482. Represents the size of the :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` enum.
  483. .. rst-class:: classref-item-separator
  484. ----
  485. .. _enum_PhysicsServer2D_BodyDampMode:
  486. .. rst-class:: classref-enumeration
  487. enum **BodyDampMode**:
  488. .. _class_PhysicsServer2D_constant_BODY_DAMP_MODE_COMBINE:
  489. .. rst-class:: classref-enumeration-constant
  490. :ref:`BodyDampMode<enum_PhysicsServer2D_BodyDampMode>` **BODY_DAMP_MODE_COMBINE** = ``0``
  491. The body's damping value is added to any value set in areas or the default value.
  492. .. _class_PhysicsServer2D_constant_BODY_DAMP_MODE_REPLACE:
  493. .. rst-class:: classref-enumeration-constant
  494. :ref:`BodyDampMode<enum_PhysicsServer2D_BodyDampMode>` **BODY_DAMP_MODE_REPLACE** = ``1``
  495. The body's damping value replaces any value set in areas or the default value.
  496. .. rst-class:: classref-item-separator
  497. ----
  498. .. _enum_PhysicsServer2D_BodyState:
  499. .. rst-class:: classref-enumeration
  500. enum **BodyState**:
  501. .. _class_PhysicsServer2D_constant_BODY_STATE_TRANSFORM:
  502. .. rst-class:: classref-enumeration-constant
  503. :ref:`BodyState<enum_PhysicsServer2D_BodyState>` **BODY_STATE_TRANSFORM** = ``0``
  504. Constant to set/get the current transform matrix of the body.
  505. .. _class_PhysicsServer2D_constant_BODY_STATE_LINEAR_VELOCITY:
  506. .. rst-class:: classref-enumeration-constant
  507. :ref:`BodyState<enum_PhysicsServer2D_BodyState>` **BODY_STATE_LINEAR_VELOCITY** = ``1``
  508. Constant to set/get the current linear velocity of the body.
  509. .. _class_PhysicsServer2D_constant_BODY_STATE_ANGULAR_VELOCITY:
  510. .. rst-class:: classref-enumeration-constant
  511. :ref:`BodyState<enum_PhysicsServer2D_BodyState>` **BODY_STATE_ANGULAR_VELOCITY** = ``2``
  512. Constant to set/get the current angular velocity of the body.
  513. .. _class_PhysicsServer2D_constant_BODY_STATE_SLEEPING:
  514. .. rst-class:: classref-enumeration-constant
  515. :ref:`BodyState<enum_PhysicsServer2D_BodyState>` **BODY_STATE_SLEEPING** = ``3``
  516. Constant to sleep/wake up a body, or to get whether it is sleeping.
  517. .. _class_PhysicsServer2D_constant_BODY_STATE_CAN_SLEEP:
  518. .. rst-class:: classref-enumeration-constant
  519. :ref:`BodyState<enum_PhysicsServer2D_BodyState>` **BODY_STATE_CAN_SLEEP** = ``4``
  520. Constant to set/get whether the body can sleep.
  521. .. rst-class:: classref-item-separator
  522. ----
  523. .. _enum_PhysicsServer2D_JointType:
  524. .. rst-class:: classref-enumeration
  525. enum **JointType**:
  526. .. _class_PhysicsServer2D_constant_JOINT_TYPE_PIN:
  527. .. rst-class:: classref-enumeration-constant
  528. :ref:`JointType<enum_PhysicsServer2D_JointType>` **JOINT_TYPE_PIN** = ``0``
  529. Constant to create pin joints.
  530. .. _class_PhysicsServer2D_constant_JOINT_TYPE_GROOVE:
  531. .. rst-class:: classref-enumeration-constant
  532. :ref:`JointType<enum_PhysicsServer2D_JointType>` **JOINT_TYPE_GROOVE** = ``1``
  533. Constant to create groove joints.
  534. .. _class_PhysicsServer2D_constant_JOINT_TYPE_DAMPED_SPRING:
  535. .. rst-class:: classref-enumeration-constant
  536. :ref:`JointType<enum_PhysicsServer2D_JointType>` **JOINT_TYPE_DAMPED_SPRING** = ``2``
  537. Constant to create damped spring joints.
  538. .. _class_PhysicsServer2D_constant_JOINT_TYPE_MAX:
  539. .. rst-class:: classref-enumeration-constant
  540. :ref:`JointType<enum_PhysicsServer2D_JointType>` **JOINT_TYPE_MAX** = ``3``
  541. Represents the size of the :ref:`JointType<enum_PhysicsServer2D_JointType>` enum.
  542. .. rst-class:: classref-item-separator
  543. ----
  544. .. _enum_PhysicsServer2D_JointParam:
  545. .. rst-class:: classref-enumeration
  546. enum **JointParam**:
  547. .. _class_PhysicsServer2D_constant_JOINT_PARAM_BIAS:
  548. .. rst-class:: classref-enumeration-constant
  549. :ref:`JointParam<enum_PhysicsServer2D_JointParam>` **JOINT_PARAM_BIAS** = ``0``
  550. .. _class_PhysicsServer2D_constant_JOINT_PARAM_MAX_BIAS:
  551. .. rst-class:: classref-enumeration-constant
  552. :ref:`JointParam<enum_PhysicsServer2D_JointParam>` **JOINT_PARAM_MAX_BIAS** = ``1``
  553. .. _class_PhysicsServer2D_constant_JOINT_PARAM_MAX_FORCE:
  554. .. rst-class:: classref-enumeration-constant
  555. :ref:`JointParam<enum_PhysicsServer2D_JointParam>` **JOINT_PARAM_MAX_FORCE** = ``2``
  556. .. rst-class:: classref-item-separator
  557. ----
  558. .. _enum_PhysicsServer2D_PinJointParam:
  559. .. rst-class:: classref-enumeration
  560. enum **PinJointParam**:
  561. .. _class_PhysicsServer2D_constant_PIN_JOINT_SOFTNESS:
  562. .. rst-class:: classref-enumeration-constant
  563. :ref:`PinJointParam<enum_PhysicsServer2D_PinJointParam>` **PIN_JOINT_SOFTNESS** = ``0``
  564. .. rst-class:: classref-item-separator
  565. ----
  566. .. _enum_PhysicsServer2D_DampedSpringParam:
  567. .. rst-class:: classref-enumeration
  568. enum **DampedSpringParam**:
  569. .. _class_PhysicsServer2D_constant_DAMPED_SPRING_REST_LENGTH:
  570. .. rst-class:: classref-enumeration-constant
  571. :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` **DAMPED_SPRING_REST_LENGTH** = ``0``
  572. Sets the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
  573. .. _class_PhysicsServer2D_constant_DAMPED_SPRING_STIFFNESS:
  574. .. rst-class:: classref-enumeration-constant
  575. :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` **DAMPED_SPRING_STIFFNESS** = ``1``
  576. Sets the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
  577. .. _class_PhysicsServer2D_constant_DAMPED_SPRING_DAMPING:
  578. .. rst-class:: classref-enumeration-constant
  579. :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` **DAMPED_SPRING_DAMPING** = ``2``
  580. 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).
  581. .. rst-class:: classref-item-separator
  582. ----
  583. .. _enum_PhysicsServer2D_CCDMode:
  584. .. rst-class:: classref-enumeration
  585. enum **CCDMode**:
  586. .. _class_PhysicsServer2D_constant_CCD_MODE_DISABLED:
  587. .. rst-class:: classref-enumeration-constant
  588. :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` **CCD_MODE_DISABLED** = ``0``
  589. Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects.
  590. .. _class_PhysicsServer2D_constant_CCD_MODE_CAST_RAY:
  591. .. rst-class:: classref-enumeration-constant
  592. :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` **CCD_MODE_CAST_RAY** = ``1``
  593. Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise.
  594. .. _class_PhysicsServer2D_constant_CCD_MODE_CAST_SHAPE:
  595. .. rst-class:: classref-enumeration-constant
  596. :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` **CCD_MODE_CAST_SHAPE** = ``2``
  597. Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise.
  598. .. rst-class:: classref-item-separator
  599. ----
  600. .. _enum_PhysicsServer2D_AreaBodyStatus:
  601. .. rst-class:: classref-enumeration
  602. enum **AreaBodyStatus**:
  603. .. _class_PhysicsServer2D_constant_AREA_BODY_ADDED:
  604. .. rst-class:: classref-enumeration-constant
  605. :ref:`AreaBodyStatus<enum_PhysicsServer2D_AreaBodyStatus>` **AREA_BODY_ADDED** = ``0``
  606. The value of the first parameter and area callback function receives, when an object enters one of its shapes.
  607. .. _class_PhysicsServer2D_constant_AREA_BODY_REMOVED:
  608. .. rst-class:: classref-enumeration-constant
  609. :ref:`AreaBodyStatus<enum_PhysicsServer2D_AreaBodyStatus>` **AREA_BODY_REMOVED** = ``1``
  610. The value of the first parameter and area callback function receives, when an object exits one of its shapes.
  611. .. rst-class:: classref-item-separator
  612. ----
  613. .. _enum_PhysicsServer2D_ProcessInfo:
  614. .. rst-class:: classref-enumeration
  615. enum **ProcessInfo**:
  616. .. _class_PhysicsServer2D_constant_INFO_ACTIVE_OBJECTS:
  617. .. rst-class:: classref-enumeration-constant
  618. :ref:`ProcessInfo<enum_PhysicsServer2D_ProcessInfo>` **INFO_ACTIVE_OBJECTS** = ``0``
  619. Constant to get the number of objects that are not sleeping.
  620. .. _class_PhysicsServer2D_constant_INFO_COLLISION_PAIRS:
  621. .. rst-class:: classref-enumeration-constant
  622. :ref:`ProcessInfo<enum_PhysicsServer2D_ProcessInfo>` **INFO_COLLISION_PAIRS** = ``1``
  623. Constant to get the number of possible collisions.
  624. .. _class_PhysicsServer2D_constant_INFO_ISLAND_COUNT:
  625. .. rst-class:: classref-enumeration-constant
  626. :ref:`ProcessInfo<enum_PhysicsServer2D_ProcessInfo>` **INFO_ISLAND_COUNT** = ``2``
  627. Constant to get the number of space regions where a collision could occur.
  628. .. rst-class:: classref-section-separator
  629. ----
  630. .. rst-class:: classref-descriptions-group
  631. Method Descriptions
  632. -------------------
  633. .. _class_PhysicsServer2D_method_area_add_shape:
  634. .. rst-class:: classref-method
  635. 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 **)**
  636. 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.
  637. .. rst-class:: classref-item-separator
  638. ----
  639. .. _class_PhysicsServer2D_method_area_attach_canvas_instance_id:
  640. .. rst-class:: classref-method
  641. void **area_attach_canvas_instance_id** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)**
  642. .. container:: contribute
  643. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  644. .. rst-class:: classref-item-separator
  645. ----
  646. .. _class_PhysicsServer2D_method_area_attach_object_instance_id:
  647. .. rst-class:: classref-method
  648. void **area_attach_object_instance_id** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)**
  649. Assigns the area to a descendant of :ref:`Object<class_Object>`, so it can exist in the node tree.
  650. .. rst-class:: classref-item-separator
  651. ----
  652. .. _class_PhysicsServer2D_method_area_clear_shapes:
  653. .. rst-class:: classref-method
  654. void **area_clear_shapes** **(** :ref:`RID<class_RID>` area **)**
  655. Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later.
  656. .. rst-class:: classref-item-separator
  657. ----
  658. .. _class_PhysicsServer2D_method_area_create:
  659. .. rst-class:: classref-method
  660. :ref:`RID<class_RID>` **area_create** **(** **)**
  661. 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_PhysicsServer2D_method_area_set_space>` to use the created :ref:`Area2D<class_Area2D>` in the physics world.
  662. .. rst-class:: classref-item-separator
  663. ----
  664. .. _class_PhysicsServer2D_method_area_get_canvas_instance_id:
  665. .. rst-class:: classref-method
  666. :ref:`int<class_int>` **area_get_canvas_instance_id** **(** :ref:`RID<class_RID>` area **)** |const|
  667. .. container:: contribute
  668. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  669. .. rst-class:: classref-item-separator
  670. ----
  671. .. _class_PhysicsServer2D_method_area_get_collision_layer:
  672. .. rst-class:: classref-method
  673. :ref:`int<class_int>` **area_get_collision_layer** **(** :ref:`RID<class_RID>` area **)** |const|
  674. Returns the physics layer or layers an area belongs to.
  675. .. rst-class:: classref-item-separator
  676. ----
  677. .. _class_PhysicsServer2D_method_area_get_collision_mask:
  678. .. rst-class:: classref-method
  679. :ref:`int<class_int>` **area_get_collision_mask** **(** :ref:`RID<class_RID>` area **)** |const|
  680. Returns the physics layer or layers an area can contact with.
  681. .. rst-class:: classref-item-separator
  682. ----
  683. .. _class_PhysicsServer2D_method_area_get_object_instance_id:
  684. .. rst-class:: classref-method
  685. :ref:`int<class_int>` **area_get_object_instance_id** **(** :ref:`RID<class_RID>` area **)** |const|
  686. Gets the instance ID of the object the area is assigned to.
  687. .. rst-class:: classref-item-separator
  688. ----
  689. .. _class_PhysicsServer2D_method_area_get_param:
  690. .. rst-class:: classref-method
  691. :ref:`Variant<class_Variant>` **area_get_param** **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` param **)** |const|
  692. Returns an area parameter value. See :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` for a list of available parameters.
  693. .. rst-class:: classref-item-separator
  694. ----
  695. .. _class_PhysicsServer2D_method_area_get_shape:
  696. .. rst-class:: classref-method
  697. :ref:`RID<class_RID>` **area_get_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |const|
  698. Returns the :ref:`RID<class_RID>` of the nth shape of an area.
  699. .. rst-class:: classref-item-separator
  700. ----
  701. .. _class_PhysicsServer2D_method_area_get_shape_count:
  702. .. rst-class:: classref-method
  703. :ref:`int<class_int>` **area_get_shape_count** **(** :ref:`RID<class_RID>` area **)** |const|
  704. Returns the number of shapes assigned to an area.
  705. .. rst-class:: classref-item-separator
  706. ----
  707. .. _class_PhysicsServer2D_method_area_get_shape_transform:
  708. .. rst-class:: classref-method
  709. :ref:`Transform2D<class_Transform2D>` **area_get_shape_transform** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |const|
  710. Returns the transform matrix of a shape within an area.
  711. .. rst-class:: classref-item-separator
  712. ----
  713. .. _class_PhysicsServer2D_method_area_get_space:
  714. .. rst-class:: classref-method
  715. :ref:`RID<class_RID>` **area_get_space** **(** :ref:`RID<class_RID>` area **)** |const|
  716. Returns the space assigned to the area.
  717. .. rst-class:: classref-item-separator
  718. ----
  719. .. _class_PhysicsServer2D_method_area_get_transform:
  720. .. rst-class:: classref-method
  721. :ref:`Transform2D<class_Transform2D>` **area_get_transform** **(** :ref:`RID<class_RID>` area **)** |const|
  722. Returns the transform matrix for an area.
  723. .. rst-class:: classref-item-separator
  724. ----
  725. .. _class_PhysicsServer2D_method_area_remove_shape:
  726. .. rst-class:: classref-method
  727. void **area_remove_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)**
  728. Removes a shape from an area. It does not delete the shape, so it can be reassigned later.
  729. .. rst-class:: classref-item-separator
  730. ----
  731. .. _class_PhysicsServer2D_method_area_set_area_monitor_callback:
  732. .. rst-class:: classref-method
  733. void **area_set_area_monitor_callback** **(** :ref:`RID<class_RID>` area, :ref:`Callable<class_Callable>` callback **)**
  734. .. container:: contribute
  735. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  736. .. rst-class:: classref-item-separator
  737. ----
  738. .. _class_PhysicsServer2D_method_area_set_collision_layer:
  739. .. rst-class:: classref-method
  740. void **area_set_collision_layer** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` layer **)**
  741. Assigns the area to one or many physics layers.
  742. .. rst-class:: classref-item-separator
  743. ----
  744. .. _class_PhysicsServer2D_method_area_set_collision_mask:
  745. .. rst-class:: classref-method
  746. void **area_set_collision_mask** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` mask **)**
  747. Sets which physics layers the area will monitor.
  748. .. rst-class:: classref-item-separator
  749. ----
  750. .. _class_PhysicsServer2D_method_area_set_monitor_callback:
  751. .. rst-class:: classref-method
  752. void **area_set_monitor_callback** **(** :ref:`RID<class_RID>` area, :ref:`Callable<class_Callable>` callback **)**
  753. 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:
  754. 1: :ref:`AREA_BODY_ADDED<class_PhysicsServer2D_constant_AREA_BODY_ADDED>` or :ref:`AREA_BODY_REMOVED<class_PhysicsServer2D_constant_AREA_BODY_REMOVED>`, depending on whether the object entered or exited the area.
  755. 2: :ref:`RID<class_RID>` of the object that entered/exited the area.
  756. 3: Instance ID of the object that entered/exited the area.
  757. 4: The shape index of the object that entered/exited the area.
  758. 5: The shape index of the area where the object entered/exited.
  759. .. rst-class:: classref-item-separator
  760. ----
  761. .. _class_PhysicsServer2D_method_area_set_monitorable:
  762. .. rst-class:: classref-method
  763. void **area_set_monitorable** **(** :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` monitorable **)**
  764. .. container:: contribute
  765. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  766. .. rst-class:: classref-item-separator
  767. ----
  768. .. _class_PhysicsServer2D_method_area_set_param:
  769. .. rst-class:: classref-method
  770. void **area_set_param** **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` param, :ref:`Variant<class_Variant>` value **)**
  771. Sets the value for an area parameter. See :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` for a list of available parameters.
  772. .. rst-class:: classref-item-separator
  773. ----
  774. .. _class_PhysicsServer2D_method_area_set_shape:
  775. .. rst-class:: classref-method
  776. void **area_set_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)**
  777. Substitutes a given area shape by another. The old shape is selected by its index, the new one by its :ref:`RID<class_RID>`.
  778. .. rst-class:: classref-item-separator
  779. ----
  780. .. _class_PhysicsServer2D_method_area_set_shape_disabled:
  781. .. rst-class:: classref-method
  782. void **area_set_shape_disabled** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)**
  783. Disables a given shape in an area.
  784. .. rst-class:: classref-item-separator
  785. ----
  786. .. _class_PhysicsServer2D_method_area_set_shape_transform:
  787. .. rst-class:: classref-method
  788. void **area_set_shape_transform** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_Transform2D>` transform **)**
  789. Sets the transform matrix for an area shape.
  790. .. rst-class:: classref-item-separator
  791. ----
  792. .. _class_PhysicsServer2D_method_area_set_space:
  793. .. rst-class:: classref-method
  794. void **area_set_space** **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` space **)**
  795. Assigns a space to the area.
  796. .. rst-class:: classref-item-separator
  797. ----
  798. .. _class_PhysicsServer2D_method_area_set_transform:
  799. .. rst-class:: classref-method
  800. void **area_set_transform** **(** :ref:`RID<class_RID>` area, :ref:`Transform2D<class_Transform2D>` transform **)**
  801. Sets the transform matrix for an area.
  802. .. rst-class:: classref-item-separator
  803. ----
  804. .. _class_PhysicsServer2D_method_body_add_collision_exception:
  805. .. rst-class:: classref-method
  806. void **body_add_collision_exception** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)**
  807. Adds a body to the list of bodies exempt from collisions.
  808. .. rst-class:: classref-item-separator
  809. ----
  810. .. _class_PhysicsServer2D_method_body_add_constant_central_force:
  811. .. rst-class:: classref-method
  812. void **body_add_constant_central_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)**
  813. Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with ``body_set_constant_force(body, Vector2(0, 0))``.
  814. This is equivalent to using :ref:`body_add_constant_force<class_PhysicsServer2D_method_body_add_constant_force>` at the body's center of mass.
  815. .. rst-class:: classref-item-separator
  816. ----
  817. .. _class_PhysicsServer2D_method_body_add_constant_force:
  818. .. rst-class:: classref-method
  819. void **body_add_constant_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force, :ref:`Vector2<class_Vector2>` position=Vector2(0, 0) **)**
  820. Adds a constant positioned force to the body that keeps being applied over time until cleared with ``body_set_constant_force(body, Vector2(0, 0))``.
  821. \ ``position`` is the offset from the body origin in global coordinates.
  822. .. rst-class:: classref-item-separator
  823. ----
  824. .. _class_PhysicsServer2D_method_body_add_constant_torque:
  825. .. rst-class:: classref-method
  826. void **body_add_constant_torque** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)**
  827. Adds a constant rotational force without affecting position that keeps being applied over time until cleared with ``body_set_constant_torque(body, 0)``.
  828. .. rst-class:: classref-item-separator
  829. ----
  830. .. _class_PhysicsServer2D_method_body_add_shape:
  831. .. rst-class:: classref-method
  832. 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 **)**
  833. 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.
  834. .. rst-class:: classref-item-separator
  835. ----
  836. .. _class_PhysicsServer2D_method_body_apply_central_force:
  837. .. rst-class:: classref-method
  838. void **body_apply_central_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)**
  839. Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update.
  840. This is equivalent to using :ref:`body_apply_force<class_PhysicsServer2D_method_body_apply_force>` at the body's center of mass.
  841. .. rst-class:: classref-item-separator
  842. ----
  843. .. _class_PhysicsServer2D_method_body_apply_central_impulse:
  844. .. rst-class:: classref-method
  845. void **body_apply_central_impulse** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` impulse **)**
  846. Applies a directional impulse without affecting rotation.
  847. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
  848. This is equivalent to using :ref:`body_apply_impulse<class_PhysicsServer2D_method_body_apply_impulse>` at the body's center of mass.
  849. .. rst-class:: classref-item-separator
  850. ----
  851. .. _class_PhysicsServer2D_method_body_apply_force:
  852. .. rst-class:: classref-method
  853. void **body_apply_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force, :ref:`Vector2<class_Vector2>` position=Vector2(0, 0) **)**
  854. Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update.
  855. \ ``position`` is the offset from the body origin in global coordinates.
  856. .. rst-class:: classref-item-separator
  857. ----
  858. .. _class_PhysicsServer2D_method_body_apply_impulse:
  859. .. rst-class:: classref-method
  860. void **body_apply_impulse** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` impulse, :ref:`Vector2<class_Vector2>` position=Vector2(0, 0) **)**
  861. Applies a positioned impulse to the body.
  862. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
  863. \ ``position`` is the offset from the body origin in global coordinates.
  864. .. rst-class:: classref-item-separator
  865. ----
  866. .. _class_PhysicsServer2D_method_body_apply_torque:
  867. .. rst-class:: classref-method
  868. void **body_apply_torque** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)**
  869. Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update.
  870. .. rst-class:: classref-item-separator
  871. ----
  872. .. _class_PhysicsServer2D_method_body_apply_torque_impulse:
  873. .. rst-class:: classref-method
  874. void **body_apply_torque_impulse** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` impulse **)**
  875. Applies a rotational impulse to the body without affecting the position.
  876. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
  877. .. rst-class:: classref-item-separator
  878. ----
  879. .. _class_PhysicsServer2D_method_body_attach_canvas_instance_id:
  880. .. rst-class:: classref-method
  881. void **body_attach_canvas_instance_id** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)**
  882. .. container:: contribute
  883. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  884. .. rst-class:: classref-item-separator
  885. ----
  886. .. _class_PhysicsServer2D_method_body_attach_object_instance_id:
  887. .. rst-class:: classref-method
  888. void **body_attach_object_instance_id** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)**
  889. Assigns the area to a descendant of :ref:`Object<class_Object>`, so it can exist in the node tree.
  890. .. rst-class:: classref-item-separator
  891. ----
  892. .. _class_PhysicsServer2D_method_body_clear_shapes:
  893. .. rst-class:: classref-method
  894. void **body_clear_shapes** **(** :ref:`RID<class_RID>` body **)**
  895. Removes all shapes from a body.
  896. .. rst-class:: classref-item-separator
  897. ----
  898. .. _class_PhysicsServer2D_method_body_create:
  899. .. rst-class:: classref-method
  900. :ref:`RID<class_RID>` **body_create** **(** **)**
  901. Creates a physics body.
  902. .. rst-class:: classref-item-separator
  903. ----
  904. .. _class_PhysicsServer2D_method_body_get_canvas_instance_id:
  905. .. rst-class:: classref-method
  906. :ref:`int<class_int>` **body_get_canvas_instance_id** **(** :ref:`RID<class_RID>` body **)** |const|
  907. .. container:: contribute
  908. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  909. .. rst-class:: classref-item-separator
  910. ----
  911. .. _class_PhysicsServer2D_method_body_get_collision_layer:
  912. .. rst-class:: classref-method
  913. :ref:`int<class_int>` **body_get_collision_layer** **(** :ref:`RID<class_RID>` body **)** |const|
  914. Returns the physics layer or layers a body belongs to.
  915. .. rst-class:: classref-item-separator
  916. ----
  917. .. _class_PhysicsServer2D_method_body_get_collision_mask:
  918. .. rst-class:: classref-method
  919. :ref:`int<class_int>` **body_get_collision_mask** **(** :ref:`RID<class_RID>` body **)** |const|
  920. Returns the physics layer or layers a body can collide with.
  921. .. rst-class:: classref-item-separator
  922. ----
  923. .. _class_PhysicsServer2D_method_body_get_collision_priority:
  924. .. rst-class:: classref-method
  925. :ref:`float<class_float>` **body_get_collision_priority** **(** :ref:`RID<class_RID>` body **)** |const|
  926. Returns the body's collision priority.
  927. .. rst-class:: classref-item-separator
  928. ----
  929. .. _class_PhysicsServer2D_method_body_get_constant_force:
  930. .. rst-class:: classref-method
  931. :ref:`Vector2<class_Vector2>` **body_get_constant_force** **(** :ref:`RID<class_RID>` body **)** |const|
  932. Returns the body's total constant positional forces applied during each physics update.
  933. See :ref:`body_add_constant_force<class_PhysicsServer2D_method_body_add_constant_force>` and :ref:`body_add_constant_central_force<class_PhysicsServer2D_method_body_add_constant_central_force>`.
  934. .. rst-class:: classref-item-separator
  935. ----
  936. .. _class_PhysicsServer2D_method_body_get_constant_torque:
  937. .. rst-class:: classref-method
  938. :ref:`float<class_float>` **body_get_constant_torque** **(** :ref:`RID<class_RID>` body **)** |const|
  939. Returns the body's total constant rotational forces applied during each physics update.
  940. See :ref:`body_add_constant_torque<class_PhysicsServer2D_method_body_add_constant_torque>`.
  941. .. rst-class:: classref-item-separator
  942. ----
  943. .. _class_PhysicsServer2D_method_body_get_continuous_collision_detection_mode:
  944. .. rst-class:: classref-method
  945. :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` **body_get_continuous_collision_detection_mode** **(** :ref:`RID<class_RID>` body **)** |const|
  946. Returns the continuous collision detection mode.
  947. .. rst-class:: classref-item-separator
  948. ----
  949. .. _class_PhysicsServer2D_method_body_get_direct_state:
  950. .. rst-class:: classref-method
  951. :ref:`PhysicsDirectBodyState2D<class_PhysicsDirectBodyState2D>` **body_get_direct_state** **(** :ref:`RID<class_RID>` body **)**
  952. Returns the :ref:`PhysicsDirectBodyState2D<class_PhysicsDirectBodyState2D>` of the body. Returns ``null`` if the body is destroyed or removed from the physics space.
  953. .. rst-class:: classref-item-separator
  954. ----
  955. .. _class_PhysicsServer2D_method_body_get_max_contacts_reported:
  956. .. rst-class:: classref-method
  957. :ref:`int<class_int>` **body_get_max_contacts_reported** **(** :ref:`RID<class_RID>` body **)** |const|
  958. Returns the maximum contacts that can be reported. See :ref:`body_set_max_contacts_reported<class_PhysicsServer2D_method_body_set_max_contacts_reported>`.
  959. .. rst-class:: classref-item-separator
  960. ----
  961. .. _class_PhysicsServer2D_method_body_get_mode:
  962. .. rst-class:: classref-method
  963. :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` **body_get_mode** **(** :ref:`RID<class_RID>` body **)** |const|
  964. Returns the body mode.
  965. .. rst-class:: classref-item-separator
  966. ----
  967. .. _class_PhysicsServer2D_method_body_get_object_instance_id:
  968. .. rst-class:: classref-method
  969. :ref:`int<class_int>` **body_get_object_instance_id** **(** :ref:`RID<class_RID>` body **)** |const|
  970. Gets the instance ID of the object the area is assigned to.
  971. .. rst-class:: classref-item-separator
  972. ----
  973. .. _class_PhysicsServer2D_method_body_get_param:
  974. .. rst-class:: classref-method
  975. :ref:`Variant<class_Variant>` **body_get_param** **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` param **)** |const|
  976. Returns the value of a body parameter. See :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` for a list of available parameters.
  977. .. rst-class:: classref-item-separator
  978. ----
  979. .. _class_PhysicsServer2D_method_body_get_shape:
  980. .. rst-class:: classref-method
  981. :ref:`RID<class_RID>` **body_get_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |const|
  982. Returns the :ref:`RID<class_RID>` of the nth shape of a body.
  983. .. rst-class:: classref-item-separator
  984. ----
  985. .. _class_PhysicsServer2D_method_body_get_shape_count:
  986. .. rst-class:: classref-method
  987. :ref:`int<class_int>` **body_get_shape_count** **(** :ref:`RID<class_RID>` body **)** |const|
  988. Returns the number of shapes assigned to a body.
  989. .. rst-class:: classref-item-separator
  990. ----
  991. .. _class_PhysicsServer2D_method_body_get_shape_transform:
  992. .. rst-class:: classref-method
  993. :ref:`Transform2D<class_Transform2D>` **body_get_shape_transform** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |const|
  994. Returns the transform matrix of a body shape.
  995. .. rst-class:: classref-item-separator
  996. ----
  997. .. _class_PhysicsServer2D_method_body_get_space:
  998. .. rst-class:: classref-method
  999. :ref:`RID<class_RID>` **body_get_space** **(** :ref:`RID<class_RID>` body **)** |const|
  1000. Returns the :ref:`RID<class_RID>` of the space assigned to a body.
  1001. .. rst-class:: classref-item-separator
  1002. ----
  1003. .. _class_PhysicsServer2D_method_body_get_state:
  1004. .. rst-class:: classref-method
  1005. :ref:`Variant<class_Variant>` **body_get_state** **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_PhysicsServer2D_BodyState>` state **)** |const|
  1006. Returns a body state.
  1007. .. rst-class:: classref-item-separator
  1008. ----
  1009. .. _class_PhysicsServer2D_method_body_is_omitting_force_integration:
  1010. .. rst-class:: classref-method
  1011. :ref:`bool<class_bool>` **body_is_omitting_force_integration** **(** :ref:`RID<class_RID>` body **)** |const|
  1012. Returns whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback<class_PhysicsServer2D_method_body_set_force_integration_callback>`).
  1013. .. rst-class:: classref-item-separator
  1014. ----
  1015. .. _class_PhysicsServer2D_method_body_remove_collision_exception:
  1016. .. rst-class:: classref-method
  1017. void **body_remove_collision_exception** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)**
  1018. Removes a body from the list of bodies exempt from collisions.
  1019. .. rst-class:: classref-item-separator
  1020. ----
  1021. .. _class_PhysicsServer2D_method_body_remove_shape:
  1022. .. rst-class:: classref-method
  1023. void **body_remove_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)**
  1024. Removes a shape from a body. The shape is not deleted, so it can be reused afterwards.
  1025. .. rst-class:: classref-item-separator
  1026. ----
  1027. .. _class_PhysicsServer2D_method_body_reset_mass_properties:
  1028. .. rst-class:: classref-method
  1029. void **body_reset_mass_properties** **(** :ref:`RID<class_RID>` body **)**
  1030. Restores the default inertia and center of mass based on shapes to cancel any custom values previously set using :ref:`body_set_param<class_PhysicsServer2D_method_body_set_param>`.
  1031. .. rst-class:: classref-item-separator
  1032. ----
  1033. .. _class_PhysicsServer2D_method_body_set_axis_velocity:
  1034. .. rst-class:: classref-method
  1035. void **body_set_axis_velocity** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` axis_velocity **)**
  1036. 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.
  1037. .. rst-class:: classref-item-separator
  1038. ----
  1039. .. _class_PhysicsServer2D_method_body_set_collision_layer:
  1040. .. rst-class:: classref-method
  1041. void **body_set_collision_layer** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` layer **)**
  1042. Sets the physics layer or layers a body belongs to.
  1043. .. rst-class:: classref-item-separator
  1044. ----
  1045. .. _class_PhysicsServer2D_method_body_set_collision_mask:
  1046. .. rst-class:: classref-method
  1047. void **body_set_collision_mask** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` mask **)**
  1048. Sets the physics layer or layers a body can collide with.
  1049. .. rst-class:: classref-item-separator
  1050. ----
  1051. .. _class_PhysicsServer2D_method_body_set_collision_priority:
  1052. .. rst-class:: classref-method
  1053. void **body_set_collision_priority** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` priority **)**
  1054. Sets the body's collision priority.
  1055. .. rst-class:: classref-item-separator
  1056. ----
  1057. .. _class_PhysicsServer2D_method_body_set_constant_force:
  1058. .. rst-class:: classref-method
  1059. void **body_set_constant_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)**
  1060. Sets the body's total constant positional forces applied during each physics update.
  1061. See :ref:`body_add_constant_force<class_PhysicsServer2D_method_body_add_constant_force>` and :ref:`body_add_constant_central_force<class_PhysicsServer2D_method_body_add_constant_central_force>`.
  1062. .. rst-class:: classref-item-separator
  1063. ----
  1064. .. _class_PhysicsServer2D_method_body_set_constant_torque:
  1065. .. rst-class:: classref-method
  1066. void **body_set_constant_torque** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)**
  1067. Sets the body's total constant rotational forces applied during each physics update.
  1068. See :ref:`body_add_constant_torque<class_PhysicsServer2D_method_body_add_constant_torque>`.
  1069. .. rst-class:: classref-item-separator
  1070. ----
  1071. .. _class_PhysicsServer2D_method_body_set_continuous_collision_detection_mode:
  1072. .. rst-class:: classref-method
  1073. void **body_set_continuous_collision_detection_mode** **(** :ref:`RID<class_RID>` body, :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` mode **)**
  1074. Sets the continuous collision detection mode using one of the :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` constants.
  1075. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
  1076. .. rst-class:: classref-item-separator
  1077. ----
  1078. .. _class_PhysicsServer2D_method_body_set_force_integration_callback:
  1079. .. rst-class:: classref-method
  1080. void **body_set_force_integration_callback** **(** :ref:`RID<class_RID>` body, :ref:`Callable<class_Callable>` callable, :ref:`Variant<class_Variant>` userdata=null **)**
  1081. Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force_integration<class_PhysicsServer2D_method_body_set_omit_force_integration>`).
  1082. The force integration function takes 2 arguments:
  1083. \ ``state:`` :ref:`PhysicsDirectBodyState2D<class_PhysicsDirectBodyState2D>` used to retrieve and modify the body's state.
  1084. \ ``userdata:`` Optional user data, if it was passed when calling ``body_set_force_integration_callback``.
  1085. .. rst-class:: classref-item-separator
  1086. ----
  1087. .. _class_PhysicsServer2D_method_body_set_max_contacts_reported:
  1088. .. rst-class:: classref-method
  1089. void **body_set_max_contacts_reported** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` amount **)**
  1090. Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies. This is enabled by setting the maximum number of contacts reported to a number greater than 0.
  1091. .. rst-class:: classref-item-separator
  1092. ----
  1093. .. _class_PhysicsServer2D_method_body_set_mode:
  1094. .. rst-class:: classref-method
  1095. void **body_set_mode** **(** :ref:`RID<class_RID>` body, :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` mode **)**
  1096. Sets the body mode using one of the :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` constants.
  1097. .. rst-class:: classref-item-separator
  1098. ----
  1099. .. _class_PhysicsServer2D_method_body_set_omit_force_integration:
  1100. .. rst-class:: classref-method
  1101. void **body_set_omit_force_integration** **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)**
  1102. Sets whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback<class_PhysicsServer2D_method_body_set_force_integration_callback>`).
  1103. .. rst-class:: classref-item-separator
  1104. ----
  1105. .. _class_PhysicsServer2D_method_body_set_param:
  1106. .. rst-class:: classref-method
  1107. void **body_set_param** **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` param, :ref:`Variant<class_Variant>` value **)**
  1108. Sets a body parameter. See :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` for a list of available parameters.
  1109. .. rst-class:: classref-item-separator
  1110. ----
  1111. .. _class_PhysicsServer2D_method_body_set_shape:
  1112. .. rst-class:: classref-method
  1113. void **body_set_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)**
  1114. Substitutes a given body shape by another. The old shape is selected by its index, the new one by its :ref:`RID<class_RID>`.
  1115. .. rst-class:: classref-item-separator
  1116. ----
  1117. .. _class_PhysicsServer2D_method_body_set_shape_as_one_way_collision:
  1118. .. rst-class:: classref-method
  1119. 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 **)**
  1120. Enables one way collision on body if ``enable`` is ``true``.
  1121. .. rst-class:: classref-item-separator
  1122. ----
  1123. .. _class_PhysicsServer2D_method_body_set_shape_disabled:
  1124. .. rst-class:: classref-method
  1125. void **body_set_shape_disabled** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)**
  1126. Disables shape in body if ``disabled`` is ``true``.
  1127. .. rst-class:: classref-item-separator
  1128. ----
  1129. .. _class_PhysicsServer2D_method_body_set_shape_transform:
  1130. .. rst-class:: classref-method
  1131. void **body_set_shape_transform** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_Transform2D>` transform **)**
  1132. Sets the transform matrix for a body shape.
  1133. .. rst-class:: classref-item-separator
  1134. ----
  1135. .. _class_PhysicsServer2D_method_body_set_space:
  1136. .. rst-class:: classref-method
  1137. void **body_set_space** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` space **)**
  1138. Assigns a space to the body (see :ref:`space_create<class_PhysicsServer2D_method_space_create>`).
  1139. .. rst-class:: classref-item-separator
  1140. ----
  1141. .. _class_PhysicsServer2D_method_body_set_state:
  1142. .. rst-class:: classref-method
  1143. void **body_set_state** **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_PhysicsServer2D_BodyState>` state, :ref:`Variant<class_Variant>` value **)**
  1144. Sets a body state using one of the :ref:`BodyState<enum_PhysicsServer2D_BodyState>` constants.
  1145. Note that the method doesn't take effect immediately. The state will change on the next physics frame.
  1146. .. rst-class:: classref-item-separator
  1147. ----
  1148. .. _class_PhysicsServer2D_method_body_test_motion:
  1149. .. rst-class:: classref-method
  1150. :ref:`bool<class_bool>` **body_test_motion** **(** :ref:`RID<class_RID>` body, :ref:`PhysicsTestMotionParameters2D<class_PhysicsTestMotionParameters2D>` parameters, :ref:`PhysicsTestMotionResult2D<class_PhysicsTestMotionResult2D>` result=null **)**
  1151. Returns ``true`` if a collision would result from moving along a motion vector from a given point in space. :ref:`PhysicsTestMotionParameters2D<class_PhysicsTestMotionParameters2D>` is passed to set motion parameters. :ref:`PhysicsTestMotionResult2D<class_PhysicsTestMotionResult2D>` can be passed to return additional information.
  1152. .. rst-class:: classref-item-separator
  1153. ----
  1154. .. _class_PhysicsServer2D_method_capsule_shape_create:
  1155. .. rst-class:: classref-method
  1156. :ref:`RID<class_RID>` **capsule_shape_create** **(** **)**
  1157. .. container:: contribute
  1158. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1159. .. rst-class:: classref-item-separator
  1160. ----
  1161. .. _class_PhysicsServer2D_method_circle_shape_create:
  1162. .. rst-class:: classref-method
  1163. :ref:`RID<class_RID>` **circle_shape_create** **(** **)**
  1164. .. container:: contribute
  1165. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1166. .. rst-class:: classref-item-separator
  1167. ----
  1168. .. _class_PhysicsServer2D_method_concave_polygon_shape_create:
  1169. .. rst-class:: classref-method
  1170. :ref:`RID<class_RID>` **concave_polygon_shape_create** **(** **)**
  1171. .. container:: contribute
  1172. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1173. .. rst-class:: classref-item-separator
  1174. ----
  1175. .. _class_PhysicsServer2D_method_convex_polygon_shape_create:
  1176. .. rst-class:: classref-method
  1177. :ref:`RID<class_RID>` **convex_polygon_shape_create** **(** **)**
  1178. .. container:: contribute
  1179. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1180. .. rst-class:: classref-item-separator
  1181. ----
  1182. .. _class_PhysicsServer2D_method_damped_spring_joint_get_param:
  1183. .. rst-class:: classref-method
  1184. :ref:`float<class_float>` **damped_spring_joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` param **)** |const|
  1185. Returns the value of a damped spring joint parameter. See :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` for a list of available parameters.
  1186. .. rst-class:: classref-item-separator
  1187. ----
  1188. .. _class_PhysicsServer2D_method_damped_spring_joint_set_param:
  1189. .. rst-class:: classref-method
  1190. void **damped_spring_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` param, :ref:`float<class_float>` value **)**
  1191. Sets a damped spring joint parameter. See :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` for a list of available parameters.
  1192. .. rst-class:: classref-item-separator
  1193. ----
  1194. .. _class_PhysicsServer2D_method_free_rid:
  1195. .. rst-class:: classref-method
  1196. void **free_rid** **(** :ref:`RID<class_RID>` rid **)**
  1197. Destroys any of the objects created by PhysicsServer2D. If the :ref:`RID<class_RID>` passed is not one of the objects that can be created by PhysicsServer2D, an error will be sent to the console.
  1198. .. rst-class:: classref-item-separator
  1199. ----
  1200. .. _class_PhysicsServer2D_method_get_process_info:
  1201. .. rst-class:: classref-method
  1202. :ref:`int<class_int>` **get_process_info** **(** :ref:`ProcessInfo<enum_PhysicsServer2D_ProcessInfo>` process_info **)**
  1203. Returns information about the current state of the 2D physics engine. See :ref:`ProcessInfo<enum_PhysicsServer2D_ProcessInfo>` for a list of available states.
  1204. .. rst-class:: classref-item-separator
  1205. ----
  1206. .. _class_PhysicsServer2D_method_joint_clear:
  1207. .. rst-class:: classref-method
  1208. void **joint_clear** **(** :ref:`RID<class_RID>` joint **)**
  1209. .. container:: contribute
  1210. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1211. .. rst-class:: classref-item-separator
  1212. ----
  1213. .. _class_PhysicsServer2D_method_joint_create:
  1214. .. rst-class:: classref-method
  1215. :ref:`RID<class_RID>` **joint_create** **(** **)**
  1216. .. container:: contribute
  1217. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1218. .. rst-class:: classref-item-separator
  1219. ----
  1220. .. _class_PhysicsServer2D_method_joint_disable_collisions_between_bodies:
  1221. .. rst-class:: classref-method
  1222. void **joint_disable_collisions_between_bodies** **(** :ref:`RID<class_RID>` joint, :ref:`bool<class_bool>` disable **)**
  1223. Sets whether the bodies attached to the :ref:`Joint2D<class_Joint2D>` will collide with each other.
  1224. .. rst-class:: classref-item-separator
  1225. ----
  1226. .. _class_PhysicsServer2D_method_joint_get_param:
  1227. .. rst-class:: classref-method
  1228. :ref:`float<class_float>` **joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_PhysicsServer2D_JointParam>` param **)** |const|
  1229. Returns the value of a joint parameter.
  1230. .. rst-class:: classref-item-separator
  1231. ----
  1232. .. _class_PhysicsServer2D_method_joint_get_type:
  1233. .. rst-class:: classref-method
  1234. :ref:`JointType<enum_PhysicsServer2D_JointType>` **joint_get_type** **(** :ref:`RID<class_RID>` joint **)** |const|
  1235. Returns a joint's type (see :ref:`JointType<enum_PhysicsServer2D_JointType>`).
  1236. .. rst-class:: classref-item-separator
  1237. ----
  1238. .. _class_PhysicsServer2D_method_joint_is_disabled_collisions_between_bodies:
  1239. .. rst-class:: classref-method
  1240. :ref:`bool<class_bool>` **joint_is_disabled_collisions_between_bodies** **(** :ref:`RID<class_RID>` joint **)** |const|
  1241. Returns whether the bodies attached to the :ref:`Joint2D<class_Joint2D>` will collide with each other.
  1242. .. rst-class:: classref-item-separator
  1243. ----
  1244. .. _class_PhysicsServer2D_method_joint_make_damped_spring:
  1245. .. rst-class:: classref-method
  1246. void **joint_make_damped_spring** **(** :ref:`RID<class_RID>` joint, :ref:`Vector2<class_Vector2>` anchor_a, :ref:`Vector2<class_Vector2>` anchor_b, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)**
  1247. .. container:: contribute
  1248. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1249. .. rst-class:: classref-item-separator
  1250. ----
  1251. .. _class_PhysicsServer2D_method_joint_make_groove:
  1252. .. rst-class:: classref-method
  1253. void **joint_make_groove** **(** :ref:`RID<class_RID>` joint, :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 **)**
  1254. .. container:: contribute
  1255. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1256. .. rst-class:: classref-item-separator
  1257. ----
  1258. .. _class_PhysicsServer2D_method_joint_make_pin:
  1259. .. rst-class:: classref-method
  1260. void **joint_make_pin** **(** :ref:`RID<class_RID>` joint, :ref:`Vector2<class_Vector2>` anchor, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)**
  1261. .. container:: contribute
  1262. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1263. .. rst-class:: classref-item-separator
  1264. ----
  1265. .. _class_PhysicsServer2D_method_joint_set_param:
  1266. .. rst-class:: classref-method
  1267. void **joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_PhysicsServer2D_JointParam>` param, :ref:`float<class_float>` value **)**
  1268. Sets a joint parameter. See :ref:`JointParam<enum_PhysicsServer2D_JointParam>` for a list of available parameters.
  1269. .. rst-class:: classref-item-separator
  1270. ----
  1271. .. _class_PhysicsServer2D_method_pin_joint_get_param:
  1272. .. rst-class:: classref-method
  1273. :ref:`float<class_float>` **pin_joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`PinJointParam<enum_PhysicsServer2D_PinJointParam>` param **)** |const|
  1274. Returns the value of a pin joint parameter. See :ref:`PinJointParam<enum_PhysicsServer2D_PinJointParam>` for a list of available parameters.
  1275. .. rst-class:: classref-item-separator
  1276. ----
  1277. .. _class_PhysicsServer2D_method_pin_joint_set_param:
  1278. .. rst-class:: classref-method
  1279. void **pin_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`PinJointParam<enum_PhysicsServer2D_PinJointParam>` param, :ref:`float<class_float>` value **)**
  1280. Sets a pin joint parameter. See :ref:`PinJointParam<enum_PhysicsServer2D_PinJointParam>` for a list of available parameters.
  1281. .. rst-class:: classref-item-separator
  1282. ----
  1283. .. _class_PhysicsServer2D_method_rectangle_shape_create:
  1284. .. rst-class:: classref-method
  1285. :ref:`RID<class_RID>` **rectangle_shape_create** **(** **)**
  1286. .. container:: contribute
  1287. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1288. .. rst-class:: classref-item-separator
  1289. ----
  1290. .. _class_PhysicsServer2D_method_segment_shape_create:
  1291. .. rst-class:: classref-method
  1292. :ref:`RID<class_RID>` **segment_shape_create** **(** **)**
  1293. .. container:: contribute
  1294. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1295. .. rst-class:: classref-item-separator
  1296. ----
  1297. .. _class_PhysicsServer2D_method_separation_ray_shape_create:
  1298. .. rst-class:: classref-method
  1299. :ref:`RID<class_RID>` **separation_ray_shape_create** **(** **)**
  1300. .. container:: contribute
  1301. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1302. .. rst-class:: classref-item-separator
  1303. ----
  1304. .. _class_PhysicsServer2D_method_set_active:
  1305. .. rst-class:: classref-method
  1306. void **set_active** **(** :ref:`bool<class_bool>` active **)**
  1307. Activates or deactivates the 2D physics engine.
  1308. .. rst-class:: classref-item-separator
  1309. ----
  1310. .. _class_PhysicsServer2D_method_shape_get_data:
  1311. .. rst-class:: classref-method
  1312. :ref:`Variant<class_Variant>` **shape_get_data** **(** :ref:`RID<class_RID>` shape **)** |const|
  1313. Returns the shape data.
  1314. .. rst-class:: classref-item-separator
  1315. ----
  1316. .. _class_PhysicsServer2D_method_shape_get_type:
  1317. .. rst-class:: classref-method
  1318. :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **shape_get_type** **(** :ref:`RID<class_RID>` shape **)** |const|
  1319. Returns a shape's type (see :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>`).
  1320. .. rst-class:: classref-item-separator
  1321. ----
  1322. .. _class_PhysicsServer2D_method_shape_set_data:
  1323. .. rst-class:: classref-method
  1324. void **shape_set_data** **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_Variant>` data **)**
  1325. 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_PhysicsServer2D_method_shape_get_type>`.
  1326. .. rst-class:: classref-item-separator
  1327. ----
  1328. .. _class_PhysicsServer2D_method_space_create:
  1329. .. rst-class:: classref-method
  1330. :ref:`RID<class_RID>` **space_create** **(** **)**
  1331. 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_PhysicsServer2D_method_area_set_space>`, or to a body with :ref:`body_set_space<class_PhysicsServer2D_method_body_set_space>`.
  1332. .. rst-class:: classref-item-separator
  1333. ----
  1334. .. _class_PhysicsServer2D_method_space_get_direct_state:
  1335. .. rst-class:: classref-method
  1336. :ref:`PhysicsDirectSpaceState2D<class_PhysicsDirectSpaceState2D>` **space_get_direct_state** **(** :ref:`RID<class_RID>` space **)**
  1337. Returns the state of a space, a :ref:`PhysicsDirectSpaceState2D<class_PhysicsDirectSpaceState2D>`. This object can be used to make collision/intersection queries.
  1338. .. rst-class:: classref-item-separator
  1339. ----
  1340. .. _class_PhysicsServer2D_method_space_get_param:
  1341. .. rst-class:: classref-method
  1342. :ref:`float<class_float>` **space_get_param** **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` param **)** |const|
  1343. Returns the value of a space parameter.
  1344. .. rst-class:: classref-item-separator
  1345. ----
  1346. .. _class_PhysicsServer2D_method_space_is_active:
  1347. .. rst-class:: classref-method
  1348. :ref:`bool<class_bool>` **space_is_active** **(** :ref:`RID<class_RID>` space **)** |const|
  1349. Returns whether the space is active.
  1350. .. rst-class:: classref-item-separator
  1351. ----
  1352. .. _class_PhysicsServer2D_method_space_set_active:
  1353. .. rst-class:: classref-method
  1354. void **space_set_active** **(** :ref:`RID<class_RID>` space, :ref:`bool<class_bool>` active **)**
  1355. Marks a space as active. It will not have an effect, unless it is assigned to an area or body.
  1356. .. rst-class:: classref-item-separator
  1357. ----
  1358. .. _class_PhysicsServer2D_method_space_set_param:
  1359. .. rst-class:: classref-method
  1360. void **space_set_param** **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` param, :ref:`float<class_float>` value **)**
  1361. Sets the value for a space parameter. See :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` for a list of available parameters.
  1362. .. rst-class:: classref-item-separator
  1363. ----
  1364. .. _class_PhysicsServer2D_method_world_boundary_shape_create:
  1365. .. rst-class:: classref-method
  1366. :ref:`RID<class_RID>` **world_boundary_shape_create** **(** **)**
  1367. .. container:: contribute
  1368. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1369. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  1370. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  1371. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  1372. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  1373. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  1374. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`