class_physicsserver3d.rst 251 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993
  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/PhysicsServer3D.xml.
  6. .. _class_PhysicsServer3D:
  7. PhysicsServer3D
  8. ===============
  9. **Inherits:** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`PhysicsServer3DExtension<class_PhysicsServer3DExtension>`
  11. A server interface for low-level 3D physics access.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. PhysicsServer3D is the server responsible for all 3D physics. It can directly create and manipulate all physics objects:
  16. - A *space* is a self-contained world for a physics simulation. It contains bodies, areas, and joints. Its state can be queried for collision and intersection information, and several parameters of the simulation can be modified.
  17. - A *shape* is a geometric shape such as a sphere, a box, a cylinder, or a polygon. It can be used for collision detection by adding it to a body/area, possibly with an extra transformation relative to the body/area's origin. Bodies/areas can have multiple (transformed) shapes added to them, and a single shape can be added to bodies/areas multiple times with different local transformations.
  18. - A *body* is a physical object which can be in static, kinematic, or rigid mode. Its state (such as position and velocity) can be queried and updated. A force integration callback can be set to customize the body's physics.
  19. - An *area* is a region in space which can be used to detect bodies and areas entering and exiting it. A body monitoring callback can be set to report entering/exiting body shapes, and similarly an area monitoring callback can be set. Gravity and damping can be overridden within the area by setting area parameters.
  20. - A *joint* is a constraint, either between two bodies or on one body relative to a point. Parameters such as the joint bias and the rest length of a spring joint can be adjusted.
  21. Physics objects in **PhysicsServer3D** may be created and manipulated independently; they do not have to be tied to nodes in the scene tree.
  22. \ **Note:** All the 3D physics nodes use the physics server internally. Adding a physics node to the scene tree will cause a corresponding physics object to be created in the physics server. A rigid body node registers a callback that updates the node's transform with the transform of the respective body object in the physics server (every physics update). An area node registers a callback to inform the area node about overlaps with the respective area object in the physics server. The raycast node queries the direct state of the relevant space in the physics server.
  23. .. rst-class:: classref-reftable-group
  24. Methods
  25. -------
  26. .. table::
  27. :widths: auto
  28. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | |void| | :ref:`area_add_shape<class_PhysicsServer3D_method_area_add_shape>`\ (\ area\: :ref:`RID<class_RID>`, shape\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>` = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), disabled\: :ref:`bool<class_bool>` = false\ ) |
  30. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | |void| | :ref:`area_attach_object_instance_id<class_PhysicsServer3D_method_area_attach_object_instance_id>`\ (\ area\: :ref:`RID<class_RID>`, id\: :ref:`int<class_int>`\ ) |
  32. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | |void| | :ref:`area_clear_shapes<class_PhysicsServer3D_method_area_clear_shapes>`\ (\ area\: :ref:`RID<class_RID>`\ ) |
  34. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`RID<class_RID>` | :ref:`area_create<class_PhysicsServer3D_method_area_create>`\ (\ ) |
  36. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | :ref:`int<class_int>` | :ref:`area_get_collision_layer<class_PhysicsServer3D_method_area_get_collision_layer>`\ (\ area\: :ref:`RID<class_RID>`\ ) |const| |
  38. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | :ref:`int<class_int>` | :ref:`area_get_collision_mask<class_PhysicsServer3D_method_area_get_collision_mask>`\ (\ area\: :ref:`RID<class_RID>`\ ) |const| |
  40. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`int<class_int>` | :ref:`area_get_object_instance_id<class_PhysicsServer3D_method_area_get_object_instance_id>`\ (\ area\: :ref:`RID<class_RID>`\ ) |const| |
  42. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | :ref:`Variant<class_Variant>` | :ref:`area_get_param<class_PhysicsServer3D_method_area_get_param>`\ (\ area\: :ref:`RID<class_RID>`, param\: :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>`\ ) |const| |
  44. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | :ref:`RID<class_RID>` | :ref:`area_get_shape<class_PhysicsServer3D_method_area_get_shape>`\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) |const| |
  46. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | :ref:`int<class_int>` | :ref:`area_get_shape_count<class_PhysicsServer3D_method_area_get_shape_count>`\ (\ area\: :ref:`RID<class_RID>`\ ) |const| |
  48. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | :ref:`Transform3D<class_Transform3D>` | :ref:`area_get_shape_transform<class_PhysicsServer3D_method_area_get_shape_transform>`\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) |const| |
  50. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | :ref:`RID<class_RID>` | :ref:`area_get_space<class_PhysicsServer3D_method_area_get_space>`\ (\ area\: :ref:`RID<class_RID>`\ ) |const| |
  52. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | :ref:`Transform3D<class_Transform3D>` | :ref:`area_get_transform<class_PhysicsServer3D_method_area_get_transform>`\ (\ area\: :ref:`RID<class_RID>`\ ) |const| |
  54. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | |void| | :ref:`area_remove_shape<class_PhysicsServer3D_method_area_remove_shape>`\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) |
  56. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | |void| | :ref:`area_set_area_monitor_callback<class_PhysicsServer3D_method_area_set_area_monitor_callback>`\ (\ area\: :ref:`RID<class_RID>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  58. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | |void| | :ref:`area_set_collision_layer<class_PhysicsServer3D_method_area_set_collision_layer>`\ (\ area\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`\ ) |
  60. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | |void| | :ref:`area_set_collision_mask<class_PhysicsServer3D_method_area_set_collision_mask>`\ (\ area\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  62. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | |void| | :ref:`area_set_monitor_callback<class_PhysicsServer3D_method_area_set_monitor_callback>`\ (\ area\: :ref:`RID<class_RID>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  64. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | |void| | :ref:`area_set_monitorable<class_PhysicsServer3D_method_area_set_monitorable>`\ (\ area\: :ref:`RID<class_RID>`, monitorable\: :ref:`bool<class_bool>`\ ) |
  66. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | |void| | :ref:`area_set_param<class_PhysicsServer3D_method_area_set_param>`\ (\ area\: :ref:`RID<class_RID>`, param\: :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>`, value\: :ref:`Variant<class_Variant>`\ ) |
  68. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | |void| | :ref:`area_set_ray_pickable<class_PhysicsServer3D_method_area_set_ray_pickable>`\ (\ area\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  70. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | |void| | :ref:`area_set_shape<class_PhysicsServer3D_method_area_set_shape>`\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, shape\: :ref:`RID<class_RID>`\ ) |
  72. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | |void| | :ref:`area_set_shape_disabled<class_PhysicsServer3D_method_area_set_shape_disabled>`\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ ) |
  74. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | |void| | :ref:`area_set_shape_transform<class_PhysicsServer3D_method_area_set_shape_transform>`\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  76. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | |void| | :ref:`area_set_space<class_PhysicsServer3D_method_area_set_space>`\ (\ area\: :ref:`RID<class_RID>`, space\: :ref:`RID<class_RID>`\ ) |
  78. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | |void| | :ref:`area_set_transform<class_PhysicsServer3D_method_area_set_transform>`\ (\ area\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  80. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | |void| | :ref:`body_add_collision_exception<class_PhysicsServer3D_method_body_add_collision_exception>`\ (\ body\: :ref:`RID<class_RID>`, excepted_body\: :ref:`RID<class_RID>`\ ) |
  82. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | |void| | :ref:`body_add_constant_central_force<class_PhysicsServer3D_method_body_add_constant_central_force>`\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`\ ) |
  84. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | |void| | :ref:`body_add_constant_force<class_PhysicsServer3D_method_body_add_constant_force>`\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) |
  86. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | |void| | :ref:`body_add_constant_torque<class_PhysicsServer3D_method_body_add_constant_torque>`\ (\ body\: :ref:`RID<class_RID>`, torque\: :ref:`Vector3<class_Vector3>`\ ) |
  88. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | |void| | :ref:`body_add_shape<class_PhysicsServer3D_method_body_add_shape>`\ (\ body\: :ref:`RID<class_RID>`, shape\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>` = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), disabled\: :ref:`bool<class_bool>` = false\ ) |
  90. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | |void| | :ref:`body_apply_central_force<class_PhysicsServer3D_method_body_apply_central_force>`\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`\ ) |
  92. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | |void| | :ref:`body_apply_central_impulse<class_PhysicsServer3D_method_body_apply_central_impulse>`\ (\ body\: :ref:`RID<class_RID>`, impulse\: :ref:`Vector3<class_Vector3>`\ ) |
  94. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | |void| | :ref:`body_apply_force<class_PhysicsServer3D_method_body_apply_force>`\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) |
  96. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | |void| | :ref:`body_apply_impulse<class_PhysicsServer3D_method_body_apply_impulse>`\ (\ body\: :ref:`RID<class_RID>`, impulse\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) |
  98. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | |void| | :ref:`body_apply_torque<class_PhysicsServer3D_method_body_apply_torque>`\ (\ body\: :ref:`RID<class_RID>`, torque\: :ref:`Vector3<class_Vector3>`\ ) |
  100. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | |void| | :ref:`body_apply_torque_impulse<class_PhysicsServer3D_method_body_apply_torque_impulse>`\ (\ body\: :ref:`RID<class_RID>`, impulse\: :ref:`Vector3<class_Vector3>`\ ) |
  102. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | |void| | :ref:`body_attach_object_instance_id<class_PhysicsServer3D_method_body_attach_object_instance_id>`\ (\ body\: :ref:`RID<class_RID>`, id\: :ref:`int<class_int>`\ ) |
  104. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | |void| | :ref:`body_clear_shapes<class_PhysicsServer3D_method_body_clear_shapes>`\ (\ body\: :ref:`RID<class_RID>`\ ) |
  106. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | :ref:`RID<class_RID>` | :ref:`body_create<class_PhysicsServer3D_method_body_create>`\ (\ ) |
  108. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | :ref:`int<class_int>` | :ref:`body_get_collision_layer<class_PhysicsServer3D_method_body_get_collision_layer>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  110. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | :ref:`int<class_int>` | :ref:`body_get_collision_mask<class_PhysicsServer3D_method_body_get_collision_mask>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  112. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | :ref:`float<class_float>` | :ref:`body_get_collision_priority<class_PhysicsServer3D_method_body_get_collision_priority>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  114. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | :ref:`Vector3<class_Vector3>` | :ref:`body_get_constant_force<class_PhysicsServer3D_method_body_get_constant_force>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  116. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | :ref:`Vector3<class_Vector3>` | :ref:`body_get_constant_torque<class_PhysicsServer3D_method_body_get_constant_torque>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  118. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>` | :ref:`body_get_direct_state<class_PhysicsServer3D_method_body_get_direct_state>`\ (\ body\: :ref:`RID<class_RID>`\ ) |
  120. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | :ref:`int<class_int>` | :ref:`body_get_max_contacts_reported<class_PhysicsServer3D_method_body_get_max_contacts_reported>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  122. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` | :ref:`body_get_mode<class_PhysicsServer3D_method_body_get_mode>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  124. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | :ref:`int<class_int>` | :ref:`body_get_object_instance_id<class_PhysicsServer3D_method_body_get_object_instance_id>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  126. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | :ref:`Variant<class_Variant>` | :ref:`body_get_param<class_PhysicsServer3D_method_body_get_param>`\ (\ body\: :ref:`RID<class_RID>`, param\: :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>`\ ) |const| |
  128. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | :ref:`RID<class_RID>` | :ref:`body_get_shape<class_PhysicsServer3D_method_body_get_shape>`\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) |const| |
  130. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | :ref:`int<class_int>` | :ref:`body_get_shape_count<class_PhysicsServer3D_method_body_get_shape_count>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  132. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | :ref:`Transform3D<class_Transform3D>` | :ref:`body_get_shape_transform<class_PhysicsServer3D_method_body_get_shape_transform>`\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) |const| |
  134. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | :ref:`RID<class_RID>` | :ref:`body_get_space<class_PhysicsServer3D_method_body_get_space>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  136. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | :ref:`Variant<class_Variant>` | :ref:`body_get_state<class_PhysicsServer3D_method_body_get_state>`\ (\ body\: :ref:`RID<class_RID>`, state\: :ref:`BodyState<enum_PhysicsServer3D_BodyState>`\ ) |const| |
  138. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | :ref:`bool<class_bool>` | :ref:`body_is_axis_locked<class_PhysicsServer3D_method_body_is_axis_locked>`\ (\ body\: :ref:`RID<class_RID>`, axis\: :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>`\ ) |const| |
  140. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | :ref:`bool<class_bool>` | :ref:`body_is_continuous_collision_detection_enabled<class_PhysicsServer3D_method_body_is_continuous_collision_detection_enabled>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  142. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | :ref:`bool<class_bool>` | :ref:`body_is_omitting_force_integration<class_PhysicsServer3D_method_body_is_omitting_force_integration>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  144. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | |void| | :ref:`body_remove_collision_exception<class_PhysicsServer3D_method_body_remove_collision_exception>`\ (\ body\: :ref:`RID<class_RID>`, excepted_body\: :ref:`RID<class_RID>`\ ) |
  146. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | |void| | :ref:`body_remove_shape<class_PhysicsServer3D_method_body_remove_shape>`\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) |
  148. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | |void| | :ref:`body_reset_mass_properties<class_PhysicsServer3D_method_body_reset_mass_properties>`\ (\ body\: :ref:`RID<class_RID>`\ ) |
  150. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | |void| | :ref:`body_set_axis_lock<class_PhysicsServer3D_method_body_set_axis_lock>`\ (\ body\: :ref:`RID<class_RID>`, axis\: :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>`, lock\: :ref:`bool<class_bool>`\ ) |
  152. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | |void| | :ref:`body_set_axis_velocity<class_PhysicsServer3D_method_body_set_axis_velocity>`\ (\ body\: :ref:`RID<class_RID>`, axis_velocity\: :ref:`Vector3<class_Vector3>`\ ) |
  154. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | |void| | :ref:`body_set_collision_layer<class_PhysicsServer3D_method_body_set_collision_layer>`\ (\ body\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`\ ) |
  156. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | |void| | :ref:`body_set_collision_mask<class_PhysicsServer3D_method_body_set_collision_mask>`\ (\ body\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  158. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | |void| | :ref:`body_set_collision_priority<class_PhysicsServer3D_method_body_set_collision_priority>`\ (\ body\: :ref:`RID<class_RID>`, priority\: :ref:`float<class_float>`\ ) |
  160. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | |void| | :ref:`body_set_constant_force<class_PhysicsServer3D_method_body_set_constant_force>`\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`\ ) |
  162. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | |void| | :ref:`body_set_constant_torque<class_PhysicsServer3D_method_body_set_constant_torque>`\ (\ body\: :ref:`RID<class_RID>`, torque\: :ref:`Vector3<class_Vector3>`\ ) |
  164. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. | |void| | :ref:`body_set_enable_continuous_collision_detection<class_PhysicsServer3D_method_body_set_enable_continuous_collision_detection>`\ (\ body\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  166. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  167. | |void| | :ref:`body_set_force_integration_callback<class_PhysicsServer3D_method_body_set_force_integration_callback>`\ (\ body\: :ref:`RID<class_RID>`, callable\: :ref:`Callable<class_Callable>`, userdata\: :ref:`Variant<class_Variant>` = null\ ) |
  168. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  169. | |void| | :ref:`body_set_max_contacts_reported<class_PhysicsServer3D_method_body_set_max_contacts_reported>`\ (\ body\: :ref:`RID<class_RID>`, amount\: :ref:`int<class_int>`\ ) |
  170. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  171. | |void| | :ref:`body_set_mode<class_PhysicsServer3D_method_body_set_mode>`\ (\ body\: :ref:`RID<class_RID>`, mode\: :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>`\ ) |
  172. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  173. | |void| | :ref:`body_set_omit_force_integration<class_PhysicsServer3D_method_body_set_omit_force_integration>`\ (\ body\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  174. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  175. | |void| | :ref:`body_set_param<class_PhysicsServer3D_method_body_set_param>`\ (\ body\: :ref:`RID<class_RID>`, param\: :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>`, value\: :ref:`Variant<class_Variant>`\ ) |
  176. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  177. | |void| | :ref:`body_set_ray_pickable<class_PhysicsServer3D_method_body_set_ray_pickable>`\ (\ body\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  178. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  179. | |void| | :ref:`body_set_shape<class_PhysicsServer3D_method_body_set_shape>`\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, shape\: :ref:`RID<class_RID>`\ ) |
  180. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  181. | |void| | :ref:`body_set_shape_disabled<class_PhysicsServer3D_method_body_set_shape_disabled>`\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ ) |
  182. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | |void| | :ref:`body_set_shape_transform<class_PhysicsServer3D_method_body_set_shape_transform>`\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  184. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | |void| | :ref:`body_set_space<class_PhysicsServer3D_method_body_set_space>`\ (\ body\: :ref:`RID<class_RID>`, space\: :ref:`RID<class_RID>`\ ) |
  186. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | |void| | :ref:`body_set_state<class_PhysicsServer3D_method_body_set_state>`\ (\ body\: :ref:`RID<class_RID>`, state\: :ref:`BodyState<enum_PhysicsServer3D_BodyState>`, value\: :ref:`Variant<class_Variant>`\ ) |
  188. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | :ref:`bool<class_bool>` | :ref:`body_test_motion<class_PhysicsServer3D_method_body_test_motion>`\ (\ body\: :ref:`RID<class_RID>`, parameters\: :ref:`PhysicsTestMotionParameters3D<class_PhysicsTestMotionParameters3D>`, result\: :ref:`PhysicsTestMotionResult3D<class_PhysicsTestMotionResult3D>` = null\ ) |
  190. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | :ref:`RID<class_RID>` | :ref:`box_shape_create<class_PhysicsServer3D_method_box_shape_create>`\ (\ ) |
  192. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | :ref:`RID<class_RID>` | :ref:`capsule_shape_create<class_PhysicsServer3D_method_capsule_shape_create>`\ (\ ) |
  194. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | :ref:`RID<class_RID>` | :ref:`concave_polygon_shape_create<class_PhysicsServer3D_method_concave_polygon_shape_create>`\ (\ ) |
  196. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | :ref:`float<class_float>` | :ref:`cone_twist_joint_get_param<class_PhysicsServer3D_method_cone_twist_joint_get_param>`\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>`\ ) |const| |
  198. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | |void| | :ref:`cone_twist_joint_set_param<class_PhysicsServer3D_method_cone_twist_joint_set_param>`\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>`, value\: :ref:`float<class_float>`\ ) |
  200. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | :ref:`RID<class_RID>` | :ref:`convex_polygon_shape_create<class_PhysicsServer3D_method_convex_polygon_shape_create>`\ (\ ) |
  202. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | :ref:`RID<class_RID>` | :ref:`custom_shape_create<class_PhysicsServer3D_method_custom_shape_create>`\ (\ ) |
  204. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | :ref:`RID<class_RID>` | :ref:`cylinder_shape_create<class_PhysicsServer3D_method_cylinder_shape_create>`\ (\ ) |
  206. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | |void| | :ref:`free_rid<class_PhysicsServer3D_method_free_rid>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  208. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | :ref:`bool<class_bool>` | :ref:`generic_6dof_joint_get_flag<class_PhysicsServer3D_method_generic_6dof_joint_get_flag>`\ (\ joint\: :ref:`RID<class_RID>`, axis\: Vector3.Axis, flag\: :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>`\ ) |const| |
  210. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | :ref:`float<class_float>` | :ref:`generic_6dof_joint_get_param<class_PhysicsServer3D_method_generic_6dof_joint_get_param>`\ (\ joint\: :ref:`RID<class_RID>`, axis\: Vector3.Axis, param\: :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>`\ ) |const| |
  212. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. | |void| | :ref:`generic_6dof_joint_set_flag<class_PhysicsServer3D_method_generic_6dof_joint_set_flag>`\ (\ joint\: :ref:`RID<class_RID>`, axis\: Vector3.Axis, flag\: :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>`, enable\: :ref:`bool<class_bool>`\ ) |
  214. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  215. | |void| | :ref:`generic_6dof_joint_set_param<class_PhysicsServer3D_method_generic_6dof_joint_set_param>`\ (\ joint\: :ref:`RID<class_RID>`, axis\: Vector3.Axis, param\: :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>`, value\: :ref:`float<class_float>`\ ) |
  216. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  217. | :ref:`int<class_int>` | :ref:`get_process_info<class_PhysicsServer3D_method_get_process_info>`\ (\ process_info\: :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>`\ ) |
  218. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  219. | :ref:`RID<class_RID>` | :ref:`heightmap_shape_create<class_PhysicsServer3D_method_heightmap_shape_create>`\ (\ ) |
  220. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  221. | :ref:`bool<class_bool>` | :ref:`hinge_joint_get_flag<class_PhysicsServer3D_method_hinge_joint_get_flag>`\ (\ joint\: :ref:`RID<class_RID>`, flag\: :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>`\ ) |const| |
  222. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  223. | :ref:`float<class_float>` | :ref:`hinge_joint_get_param<class_PhysicsServer3D_method_hinge_joint_get_param>`\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>`\ ) |const| |
  224. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  225. | |void| | :ref:`hinge_joint_set_flag<class_PhysicsServer3D_method_hinge_joint_set_flag>`\ (\ joint\: :ref:`RID<class_RID>`, flag\: :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>`, enabled\: :ref:`bool<class_bool>`\ ) |
  226. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  227. | |void| | :ref:`hinge_joint_set_param<class_PhysicsServer3D_method_hinge_joint_set_param>`\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>`, value\: :ref:`float<class_float>`\ ) |
  228. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  229. | |void| | :ref:`joint_clear<class_PhysicsServer3D_method_joint_clear>`\ (\ joint\: :ref:`RID<class_RID>`\ ) |
  230. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  231. | :ref:`RID<class_RID>` | :ref:`joint_create<class_PhysicsServer3D_method_joint_create>`\ (\ ) |
  232. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  233. | |void| | :ref:`joint_disable_collisions_between_bodies<class_PhysicsServer3D_method_joint_disable_collisions_between_bodies>`\ (\ joint\: :ref:`RID<class_RID>`, disable\: :ref:`bool<class_bool>`\ ) |
  234. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  235. | :ref:`int<class_int>` | :ref:`joint_get_solver_priority<class_PhysicsServer3D_method_joint_get_solver_priority>`\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| |
  236. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  237. | :ref:`JointType<enum_PhysicsServer3D_JointType>` | :ref:`joint_get_type<class_PhysicsServer3D_method_joint_get_type>`\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| |
  238. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  239. | :ref:`bool<class_bool>` | :ref:`joint_is_disabled_collisions_between_bodies<class_PhysicsServer3D_method_joint_is_disabled_collisions_between_bodies>`\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| |
  240. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  241. | |void| | :ref:`joint_make_cone_twist<class_PhysicsServer3D_method_joint_make_cone_twist>`\ (\ joint\: :ref:`RID<class_RID>`, body_A\: :ref:`RID<class_RID>`, local_ref_A\: :ref:`Transform3D<class_Transform3D>`, body_B\: :ref:`RID<class_RID>`, local_ref_B\: :ref:`Transform3D<class_Transform3D>`\ ) |
  242. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  243. | |void| | :ref:`joint_make_generic_6dof<class_PhysicsServer3D_method_joint_make_generic_6dof>`\ (\ joint\: :ref:`RID<class_RID>`, body_A\: :ref:`RID<class_RID>`, local_ref_A\: :ref:`Transform3D<class_Transform3D>`, body_B\: :ref:`RID<class_RID>`, local_ref_B\: :ref:`Transform3D<class_Transform3D>`\ ) |
  244. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  245. | |void| | :ref:`joint_make_hinge<class_PhysicsServer3D_method_joint_make_hinge>`\ (\ joint\: :ref:`RID<class_RID>`, body_A\: :ref:`RID<class_RID>`, hinge_A\: :ref:`Transform3D<class_Transform3D>`, body_B\: :ref:`RID<class_RID>`, hinge_B\: :ref:`Transform3D<class_Transform3D>`\ ) |
  246. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  247. | |void| | :ref:`joint_make_pin<class_PhysicsServer3D_method_joint_make_pin>`\ (\ joint\: :ref:`RID<class_RID>`, body_A\: :ref:`RID<class_RID>`, local_A\: :ref:`Vector3<class_Vector3>`, body_B\: :ref:`RID<class_RID>`, local_B\: :ref:`Vector3<class_Vector3>`\ ) |
  248. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  249. | |void| | :ref:`joint_make_slider<class_PhysicsServer3D_method_joint_make_slider>`\ (\ joint\: :ref:`RID<class_RID>`, body_A\: :ref:`RID<class_RID>`, local_ref_A\: :ref:`Transform3D<class_Transform3D>`, body_B\: :ref:`RID<class_RID>`, local_ref_B\: :ref:`Transform3D<class_Transform3D>`\ ) |
  250. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  251. | |void| | :ref:`joint_set_solver_priority<class_PhysicsServer3D_method_joint_set_solver_priority>`\ (\ joint\: :ref:`RID<class_RID>`, priority\: :ref:`int<class_int>`\ ) |
  252. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  253. | :ref:`Vector3<class_Vector3>` | :ref:`pin_joint_get_local_a<class_PhysicsServer3D_method_pin_joint_get_local_a>`\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| |
  254. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  255. | :ref:`Vector3<class_Vector3>` | :ref:`pin_joint_get_local_b<class_PhysicsServer3D_method_pin_joint_get_local_b>`\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| |
  256. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  257. | :ref:`float<class_float>` | :ref:`pin_joint_get_param<class_PhysicsServer3D_method_pin_joint_get_param>`\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>`\ ) |const| |
  258. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  259. | |void| | :ref:`pin_joint_set_local_a<class_PhysicsServer3D_method_pin_joint_set_local_a>`\ (\ joint\: :ref:`RID<class_RID>`, local_A\: :ref:`Vector3<class_Vector3>`\ ) |
  260. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  261. | |void| | :ref:`pin_joint_set_local_b<class_PhysicsServer3D_method_pin_joint_set_local_b>`\ (\ joint\: :ref:`RID<class_RID>`, local_B\: :ref:`Vector3<class_Vector3>`\ ) |
  262. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  263. | |void| | :ref:`pin_joint_set_param<class_PhysicsServer3D_method_pin_joint_set_param>`\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>`, value\: :ref:`float<class_float>`\ ) |
  264. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  265. | :ref:`RID<class_RID>` | :ref:`separation_ray_shape_create<class_PhysicsServer3D_method_separation_ray_shape_create>`\ (\ ) |
  266. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  267. | |void| | :ref:`set_active<class_PhysicsServer3D_method_set_active>`\ (\ active\: :ref:`bool<class_bool>`\ ) |
  268. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  269. | :ref:`Variant<class_Variant>` | :ref:`shape_get_data<class_PhysicsServer3D_method_shape_get_data>`\ (\ shape\: :ref:`RID<class_RID>`\ ) |const| |
  270. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  271. | :ref:`float<class_float>` | :ref:`shape_get_margin<class_PhysicsServer3D_method_shape_get_margin>`\ (\ shape\: :ref:`RID<class_RID>`\ ) |const| |
  272. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  273. | :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` | :ref:`shape_get_type<class_PhysicsServer3D_method_shape_get_type>`\ (\ shape\: :ref:`RID<class_RID>`\ ) |const| |
  274. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  275. | |void| | :ref:`shape_set_data<class_PhysicsServer3D_method_shape_set_data>`\ (\ shape\: :ref:`RID<class_RID>`, data\: :ref:`Variant<class_Variant>`\ ) |
  276. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  277. | |void| | :ref:`shape_set_margin<class_PhysicsServer3D_method_shape_set_margin>`\ (\ shape\: :ref:`RID<class_RID>`, margin\: :ref:`float<class_float>`\ ) |
  278. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  279. | :ref:`float<class_float>` | :ref:`slider_joint_get_param<class_PhysicsServer3D_method_slider_joint_get_param>`\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>`\ ) |const| |
  280. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  281. | |void| | :ref:`slider_joint_set_param<class_PhysicsServer3D_method_slider_joint_set_param>`\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>`, value\: :ref:`float<class_float>`\ ) |
  282. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  283. | |void| | :ref:`soft_body_add_collision_exception<class_PhysicsServer3D_method_soft_body_add_collision_exception>`\ (\ body\: :ref:`RID<class_RID>`, body_b\: :ref:`RID<class_RID>`\ ) |
  284. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  285. | :ref:`RID<class_RID>` | :ref:`soft_body_create<class_PhysicsServer3D_method_soft_body_create>`\ (\ ) |
  286. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  287. | :ref:`AABB<class_AABB>` | :ref:`soft_body_get_bounds<class_PhysicsServer3D_method_soft_body_get_bounds>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  288. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  289. | :ref:`int<class_int>` | :ref:`soft_body_get_collision_layer<class_PhysicsServer3D_method_soft_body_get_collision_layer>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  290. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  291. | :ref:`int<class_int>` | :ref:`soft_body_get_collision_mask<class_PhysicsServer3D_method_soft_body_get_collision_mask>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  292. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  293. | :ref:`float<class_float>` | :ref:`soft_body_get_damping_coefficient<class_PhysicsServer3D_method_soft_body_get_damping_coefficient>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  294. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  295. | :ref:`float<class_float>` | :ref:`soft_body_get_drag_coefficient<class_PhysicsServer3D_method_soft_body_get_drag_coefficient>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  296. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  297. | :ref:`float<class_float>` | :ref:`soft_body_get_linear_stiffness<class_PhysicsServer3D_method_soft_body_get_linear_stiffness>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  298. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  299. | :ref:`Vector3<class_Vector3>` | :ref:`soft_body_get_point_global_position<class_PhysicsServer3D_method_soft_body_get_point_global_position>`\ (\ body\: :ref:`RID<class_RID>`, point_index\: :ref:`int<class_int>`\ ) |const| |
  300. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  301. | :ref:`float<class_float>` | :ref:`soft_body_get_pressure_coefficient<class_PhysicsServer3D_method_soft_body_get_pressure_coefficient>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  302. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  303. | :ref:`int<class_int>` | :ref:`soft_body_get_simulation_precision<class_PhysicsServer3D_method_soft_body_get_simulation_precision>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  304. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  305. | :ref:`RID<class_RID>` | :ref:`soft_body_get_space<class_PhysicsServer3D_method_soft_body_get_space>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  306. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  307. | :ref:`Variant<class_Variant>` | :ref:`soft_body_get_state<class_PhysicsServer3D_method_soft_body_get_state>`\ (\ body\: :ref:`RID<class_RID>`, state\: :ref:`BodyState<enum_PhysicsServer3D_BodyState>`\ ) |const| |
  308. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  309. | :ref:`float<class_float>` | :ref:`soft_body_get_total_mass<class_PhysicsServer3D_method_soft_body_get_total_mass>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  310. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  311. | :ref:`bool<class_bool>` | :ref:`soft_body_is_point_pinned<class_PhysicsServer3D_method_soft_body_is_point_pinned>`\ (\ body\: :ref:`RID<class_RID>`, point_index\: :ref:`int<class_int>`\ ) |const| |
  312. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  313. | |void| | :ref:`soft_body_move_point<class_PhysicsServer3D_method_soft_body_move_point>`\ (\ body\: :ref:`RID<class_RID>`, point_index\: :ref:`int<class_int>`, global_position\: :ref:`Vector3<class_Vector3>`\ ) |
  314. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  315. | |void| | :ref:`soft_body_pin_point<class_PhysicsServer3D_method_soft_body_pin_point>`\ (\ body\: :ref:`RID<class_RID>`, point_index\: :ref:`int<class_int>`, pin\: :ref:`bool<class_bool>`\ ) |
  316. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  317. | |void| | :ref:`soft_body_remove_all_pinned_points<class_PhysicsServer3D_method_soft_body_remove_all_pinned_points>`\ (\ body\: :ref:`RID<class_RID>`\ ) |
  318. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  319. | |void| | :ref:`soft_body_remove_collision_exception<class_PhysicsServer3D_method_soft_body_remove_collision_exception>`\ (\ body\: :ref:`RID<class_RID>`, body_b\: :ref:`RID<class_RID>`\ ) |
  320. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  321. | |void| | :ref:`soft_body_set_collision_layer<class_PhysicsServer3D_method_soft_body_set_collision_layer>`\ (\ body\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`\ ) |
  322. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  323. | |void| | :ref:`soft_body_set_collision_mask<class_PhysicsServer3D_method_soft_body_set_collision_mask>`\ (\ body\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  324. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  325. | |void| | :ref:`soft_body_set_damping_coefficient<class_PhysicsServer3D_method_soft_body_set_damping_coefficient>`\ (\ body\: :ref:`RID<class_RID>`, damping_coefficient\: :ref:`float<class_float>`\ ) |
  326. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  327. | |void| | :ref:`soft_body_set_drag_coefficient<class_PhysicsServer3D_method_soft_body_set_drag_coefficient>`\ (\ body\: :ref:`RID<class_RID>`, drag_coefficient\: :ref:`float<class_float>`\ ) |
  328. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  329. | |void| | :ref:`soft_body_set_linear_stiffness<class_PhysicsServer3D_method_soft_body_set_linear_stiffness>`\ (\ body\: :ref:`RID<class_RID>`, stiffness\: :ref:`float<class_float>`\ ) |
  330. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  331. | |void| | :ref:`soft_body_set_mesh<class_PhysicsServer3D_method_soft_body_set_mesh>`\ (\ body\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`\ ) |
  332. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  333. | |void| | :ref:`soft_body_set_pressure_coefficient<class_PhysicsServer3D_method_soft_body_set_pressure_coefficient>`\ (\ body\: :ref:`RID<class_RID>`, pressure_coefficient\: :ref:`float<class_float>`\ ) |
  334. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  335. | |void| | :ref:`soft_body_set_ray_pickable<class_PhysicsServer3D_method_soft_body_set_ray_pickable>`\ (\ body\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  336. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  337. | |void| | :ref:`soft_body_set_simulation_precision<class_PhysicsServer3D_method_soft_body_set_simulation_precision>`\ (\ body\: :ref:`RID<class_RID>`, simulation_precision\: :ref:`int<class_int>`\ ) |
  338. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  339. | |void| | :ref:`soft_body_set_space<class_PhysicsServer3D_method_soft_body_set_space>`\ (\ body\: :ref:`RID<class_RID>`, space\: :ref:`RID<class_RID>`\ ) |
  340. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  341. | |void| | :ref:`soft_body_set_state<class_PhysicsServer3D_method_soft_body_set_state>`\ (\ body\: :ref:`RID<class_RID>`, state\: :ref:`BodyState<enum_PhysicsServer3D_BodyState>`, variant\: :ref:`Variant<class_Variant>`\ ) |
  342. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  343. | |void| | :ref:`soft_body_set_total_mass<class_PhysicsServer3D_method_soft_body_set_total_mass>`\ (\ body\: :ref:`RID<class_RID>`, total_mass\: :ref:`float<class_float>`\ ) |
  344. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  345. | |void| | :ref:`soft_body_set_transform<class_PhysicsServer3D_method_soft_body_set_transform>`\ (\ body\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  346. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  347. | |void| | :ref:`soft_body_update_rendering_server<class_PhysicsServer3D_method_soft_body_update_rendering_server>`\ (\ body\: :ref:`RID<class_RID>`, rendering_server_handler\: :ref:`PhysicsServer3DRenderingServerHandler<class_PhysicsServer3DRenderingServerHandler>`\ ) |
  348. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  349. | :ref:`RID<class_RID>` | :ref:`space_create<class_PhysicsServer3D_method_space_create>`\ (\ ) |
  350. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  351. | :ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>` | :ref:`space_get_direct_state<class_PhysicsServer3D_method_space_get_direct_state>`\ (\ space\: :ref:`RID<class_RID>`\ ) |
  352. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  353. | :ref:`float<class_float>` | :ref:`space_get_param<class_PhysicsServer3D_method_space_get_param>`\ (\ space\: :ref:`RID<class_RID>`, param\: :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>`\ ) |const| |
  354. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  355. | :ref:`bool<class_bool>` | :ref:`space_is_active<class_PhysicsServer3D_method_space_is_active>`\ (\ space\: :ref:`RID<class_RID>`\ ) |const| |
  356. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  357. | |void| | :ref:`space_set_active<class_PhysicsServer3D_method_space_set_active>`\ (\ space\: :ref:`RID<class_RID>`, active\: :ref:`bool<class_bool>`\ ) |
  358. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  359. | |void| | :ref:`space_set_param<class_PhysicsServer3D_method_space_set_param>`\ (\ space\: :ref:`RID<class_RID>`, param\: :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>`, value\: :ref:`float<class_float>`\ ) |
  360. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  361. | :ref:`RID<class_RID>` | :ref:`sphere_shape_create<class_PhysicsServer3D_method_sphere_shape_create>`\ (\ ) |
  362. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  363. | :ref:`RID<class_RID>` | :ref:`world_boundary_shape_create<class_PhysicsServer3D_method_world_boundary_shape_create>`\ (\ ) |
  364. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  365. .. rst-class:: classref-section-separator
  366. ----
  367. .. rst-class:: classref-descriptions-group
  368. Enumerations
  369. ------------
  370. .. _enum_PhysicsServer3D_JointType:
  371. .. rst-class:: classref-enumeration
  372. enum **JointType**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_JointType>`
  373. .. _class_PhysicsServer3D_constant_JOINT_TYPE_PIN:
  374. .. rst-class:: classref-enumeration-constant
  375. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_PIN** = ``0``
  376. The :ref:`Joint3D<class_Joint3D>` is a :ref:`PinJoint3D<class_PinJoint3D>`.
  377. .. _class_PhysicsServer3D_constant_JOINT_TYPE_HINGE:
  378. .. rst-class:: classref-enumeration-constant
  379. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_HINGE** = ``1``
  380. The :ref:`Joint3D<class_Joint3D>` is a :ref:`HingeJoint3D<class_HingeJoint3D>`.
  381. .. _class_PhysicsServer3D_constant_JOINT_TYPE_SLIDER:
  382. .. rst-class:: classref-enumeration-constant
  383. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_SLIDER** = ``2``
  384. The :ref:`Joint3D<class_Joint3D>` is a :ref:`SliderJoint3D<class_SliderJoint3D>`.
  385. .. _class_PhysicsServer3D_constant_JOINT_TYPE_CONE_TWIST:
  386. .. rst-class:: classref-enumeration-constant
  387. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_CONE_TWIST** = ``3``
  388. The :ref:`Joint3D<class_Joint3D>` is a :ref:`ConeTwistJoint3D<class_ConeTwistJoint3D>`.
  389. .. _class_PhysicsServer3D_constant_JOINT_TYPE_6DOF:
  390. .. rst-class:: classref-enumeration-constant
  391. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_6DOF** = ``4``
  392. The :ref:`Joint3D<class_Joint3D>` is a :ref:`Generic6DOFJoint3D<class_Generic6DOFJoint3D>`.
  393. .. _class_PhysicsServer3D_constant_JOINT_TYPE_MAX:
  394. .. rst-class:: classref-enumeration-constant
  395. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_MAX** = ``5``
  396. Represents the size of the :ref:`JointType<enum_PhysicsServer3D_JointType>` enum.
  397. .. rst-class:: classref-item-separator
  398. ----
  399. .. _enum_PhysicsServer3D_PinJointParam:
  400. .. rst-class:: classref-enumeration
  401. enum **PinJointParam**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_PinJointParam>`
  402. .. _class_PhysicsServer3D_constant_PIN_JOINT_BIAS:
  403. .. rst-class:: classref-enumeration-constant
  404. :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` **PIN_JOINT_BIAS** = ``0``
  405. The strength with which the pinned objects try to stay in positional relation to each other.
  406. The higher, the stronger.
  407. .. _class_PhysicsServer3D_constant_PIN_JOINT_DAMPING:
  408. .. rst-class:: classref-enumeration-constant
  409. :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` **PIN_JOINT_DAMPING** = ``1``
  410. The strength with which the pinned objects try to stay in velocity relation to each other.
  411. The higher, the stronger.
  412. .. _class_PhysicsServer3D_constant_PIN_JOINT_IMPULSE_CLAMP:
  413. .. rst-class:: classref-enumeration-constant
  414. :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` **PIN_JOINT_IMPULSE_CLAMP** = ``2``
  415. If above 0, this value is the maximum value for an impulse that this Joint3D puts on its ends.
  416. .. rst-class:: classref-item-separator
  417. ----
  418. .. _enum_PhysicsServer3D_HingeJointParam:
  419. .. rst-class:: classref-enumeration
  420. enum **HingeJointParam**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_HingeJointParam>`
  421. .. _class_PhysicsServer3D_constant_HINGE_JOINT_BIAS:
  422. .. rst-class:: classref-enumeration-constant
  423. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_BIAS** = ``0``
  424. The speed with which the two bodies get pulled together when they move in different directions.
  425. .. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_UPPER:
  426. .. rst-class:: classref-enumeration-constant
  427. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_LIMIT_UPPER** = ``1``
  428. The maximum rotation across the Hinge.
  429. .. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_LOWER:
  430. .. rst-class:: classref-enumeration-constant
  431. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_LIMIT_LOWER** = ``2``
  432. The minimum rotation across the Hinge.
  433. .. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_BIAS:
  434. .. rst-class:: classref-enumeration-constant
  435. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_LIMIT_BIAS** = ``3``
  436. The speed with which the rotation across the axis perpendicular to the hinge gets corrected.
  437. .. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_SOFTNESS:
  438. .. rst-class:: classref-enumeration-constant
  439. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_LIMIT_SOFTNESS** = ``4``
  440. .. container:: contribute
  441. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  442. .. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_RELAXATION:
  443. .. rst-class:: classref-enumeration-constant
  444. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_LIMIT_RELAXATION** = ``5``
  445. The lower this value, the more the rotation gets slowed down.
  446. .. _class_PhysicsServer3D_constant_HINGE_JOINT_MOTOR_TARGET_VELOCITY:
  447. .. rst-class:: classref-enumeration-constant
  448. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_MOTOR_TARGET_VELOCITY** = ``6``
  449. Target speed for the motor.
  450. .. _class_PhysicsServer3D_constant_HINGE_JOINT_MOTOR_MAX_IMPULSE:
  451. .. rst-class:: classref-enumeration-constant
  452. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_MOTOR_MAX_IMPULSE** = ``7``
  453. Maximum acceleration for the motor.
  454. .. rst-class:: classref-item-separator
  455. ----
  456. .. _enum_PhysicsServer3D_HingeJointFlag:
  457. .. rst-class:: classref-enumeration
  458. enum **HingeJointFlag**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_HingeJointFlag>`
  459. .. _class_PhysicsServer3D_constant_HINGE_JOINT_FLAG_USE_LIMIT:
  460. .. rst-class:: classref-enumeration-constant
  461. :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` **HINGE_JOINT_FLAG_USE_LIMIT** = ``0``
  462. If ``true``, the Hinge has a maximum and a minimum rotation.
  463. .. _class_PhysicsServer3D_constant_HINGE_JOINT_FLAG_ENABLE_MOTOR:
  464. .. rst-class:: classref-enumeration-constant
  465. :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` **HINGE_JOINT_FLAG_ENABLE_MOTOR** = ``1``
  466. If ``true``, a motor turns the Hinge.
  467. .. rst-class:: classref-item-separator
  468. ----
  469. .. _enum_PhysicsServer3D_SliderJointParam:
  470. .. rst-class:: classref-enumeration
  471. enum **SliderJointParam**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_SliderJointParam>`
  472. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_UPPER:
  473. .. rst-class:: classref-enumeration-constant
  474. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_LIMIT_UPPER** = ``0``
  475. The maximum difference between the pivot points on their X axis before damping happens.
  476. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_LOWER:
  477. .. rst-class:: classref-enumeration-constant
  478. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_LIMIT_LOWER** = ``1``
  479. The minimum difference between the pivot points on their X axis before damping happens.
  480. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS:
  481. .. rst-class:: classref-enumeration-constant
  482. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS** = ``2``
  483. A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.
  484. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION:
  485. .. rst-class:: classref-enumeration-constant
  486. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION** = ``3``
  487. The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost.
  488. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_DAMPING:
  489. .. rst-class:: classref-enumeration-constant
  490. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_LIMIT_DAMPING** = ``4``
  491. The amount of damping once the slider limits are surpassed.
  492. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_MOTION_SOFTNESS:
  493. .. rst-class:: classref-enumeration-constant
  494. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_MOTION_SOFTNESS** = ``5``
  495. A factor applied to the movement across the slider axis as long as the slider is in the limits. The lower, the slower the movement.
  496. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_MOTION_RESTITUTION:
  497. .. rst-class:: classref-enumeration-constant
  498. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_MOTION_RESTITUTION** = ``6``
  499. The amount of restitution inside the slider limits.
  500. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_MOTION_DAMPING:
  501. .. rst-class:: classref-enumeration-constant
  502. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_MOTION_DAMPING** = ``7``
  503. The amount of damping inside the slider limits.
  504. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS:
  505. .. rst-class:: classref-enumeration-constant
  506. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS** = ``8``
  507. A factor applied to the movement across axes orthogonal to the slider.
  508. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION:
  509. .. rst-class:: classref-enumeration-constant
  510. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION** = ``9``
  511. The amount of restitution when movement is across axes orthogonal to the slider.
  512. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING:
  513. .. rst-class:: classref-enumeration-constant
  514. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING** = ``10``
  515. The amount of damping when movement is across axes orthogonal to the slider.
  516. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_UPPER:
  517. .. rst-class:: classref-enumeration-constant
  518. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_LIMIT_UPPER** = ``11``
  519. The upper limit of rotation in the slider.
  520. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_LOWER:
  521. .. rst-class:: classref-enumeration-constant
  522. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_LIMIT_LOWER** = ``12``
  523. The lower limit of rotation in the slider.
  524. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS:
  525. .. rst-class:: classref-enumeration-constant
  526. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS** = ``13``
  527. A factor applied to the all rotation once the limit is surpassed.
  528. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION:
  529. .. rst-class:: classref-enumeration-constant
  530. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION** = ``14``
  531. The amount of restitution of the rotation when the limit is surpassed.
  532. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_DAMPING:
  533. .. rst-class:: classref-enumeration-constant
  534. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_LIMIT_DAMPING** = ``15``
  535. The amount of damping of the rotation when the limit is surpassed.
  536. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS:
  537. .. rst-class:: classref-enumeration-constant
  538. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS** = ``16``
  539. A factor that gets applied to the all rotation in the limits.
  540. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION:
  541. .. rst-class:: classref-enumeration-constant
  542. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION** = ``17``
  543. The amount of restitution of the rotation in the limits.
  544. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_MOTION_DAMPING:
  545. .. rst-class:: classref-enumeration-constant
  546. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_MOTION_DAMPING** = ``18``
  547. The amount of damping of the rotation in the limits.
  548. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS:
  549. .. rst-class:: classref-enumeration-constant
  550. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS** = ``19``
  551. A factor that gets applied to the all rotation across axes orthogonal to the slider.
  552. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION:
  553. .. rst-class:: classref-enumeration-constant
  554. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION** = ``20``
  555. The amount of restitution of the rotation across axes orthogonal to the slider.
  556. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING:
  557. .. rst-class:: classref-enumeration-constant
  558. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING** = ``21``
  559. The amount of damping of the rotation across axes orthogonal to the slider.
  560. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_MAX:
  561. .. rst-class:: classref-enumeration-constant
  562. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_MAX** = ``22``
  563. Represents the size of the :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` enum.
  564. .. rst-class:: classref-item-separator
  565. ----
  566. .. _enum_PhysicsServer3D_ConeTwistJointParam:
  567. .. rst-class:: classref-enumeration
  568. enum **ConeTwistJointParam**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_ConeTwistJointParam>`
  569. .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_SWING_SPAN:
  570. .. rst-class:: classref-enumeration-constant
  571. :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` **CONE_TWIST_JOINT_SWING_SPAN** = ``0``
  572. Swing is rotation from side to side, around the axis perpendicular to the twist axis.
  573. The swing span defines, how much rotation will not get corrected along the swing axis.
  574. Could be defined as looseness in the :ref:`ConeTwistJoint3D<class_ConeTwistJoint3D>`.
  575. If below 0.05, this behavior is locked.
  576. .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_TWIST_SPAN:
  577. .. rst-class:: classref-enumeration-constant
  578. :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` **CONE_TWIST_JOINT_TWIST_SPAN** = ``1``
  579. Twist is the rotation around the twist axis, this value defined how far the joint can twist.
  580. Twist is locked if below 0.05.
  581. .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_BIAS:
  582. .. rst-class:: classref-enumeration-constant
  583. :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` **CONE_TWIST_JOINT_BIAS** = ``2``
  584. The speed with which the swing or twist will take place.
  585. The higher, the faster.
  586. .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_SOFTNESS:
  587. .. rst-class:: classref-enumeration-constant
  588. :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` **CONE_TWIST_JOINT_SOFTNESS** = ``3``
  589. The ease with which the Joint3D twists, if it's too low, it takes more force to twist the joint.
  590. .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_RELAXATION:
  591. .. rst-class:: classref-enumeration-constant
  592. :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` **CONE_TWIST_JOINT_RELAXATION** = ``4``
  593. Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
  594. .. rst-class:: classref-item-separator
  595. ----
  596. .. _enum_PhysicsServer3D_G6DOFJointAxisParam:
  597. .. rst-class:: classref-enumeration
  598. enum **G6DOFJointAxisParam**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_G6DOFJointAxisParam>`
  599. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_LOWER_LIMIT:
  600. .. rst-class:: classref-enumeration-constant
  601. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_LOWER_LIMIT** = ``0``
  602. The minimum difference between the pivot points' axes.
  603. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_UPPER_LIMIT:
  604. .. rst-class:: classref-enumeration-constant
  605. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_UPPER_LIMIT** = ``1``
  606. The maximum difference between the pivot points' axes.
  607. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS:
  608. .. rst-class:: classref-enumeration-constant
  609. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS** = ``2``
  610. A factor that gets applied to the movement across the axes. The lower, the slower the movement.
  611. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_RESTITUTION:
  612. .. rst-class:: classref-enumeration-constant
  613. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_RESTITUTION** = ``3``
  614. The amount of restitution on the axes movement. The lower, the more velocity-energy gets lost.
  615. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_DAMPING:
  616. .. rst-class:: classref-enumeration-constant
  617. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_DAMPING** = ``4``
  618. The amount of damping that happens at the linear motion across the axes.
  619. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_MOTOR_TARGET_VELOCITY:
  620. .. rst-class:: classref-enumeration-constant
  621. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_MOTOR_TARGET_VELOCITY** = ``5``
  622. The velocity that the joint's linear motor will attempt to reach.
  623. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_MOTOR_FORCE_LIMIT:
  624. .. rst-class:: classref-enumeration-constant
  625. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_MOTOR_FORCE_LIMIT** = ``6``
  626. The maximum force that the linear motor can apply while trying to reach the target velocity.
  627. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_SPRING_STIFFNESS:
  628. .. rst-class:: classref-enumeration-constant
  629. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_SPRING_STIFFNESS** = ``7``
  630. .. container:: contribute
  631. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  632. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_SPRING_DAMPING:
  633. .. rst-class:: classref-enumeration-constant
  634. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_SPRING_DAMPING** = ``8``
  635. .. container:: contribute
  636. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  637. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_SPRING_EQUILIBRIUM_POINT:
  638. .. rst-class:: classref-enumeration-constant
  639. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_SPRING_EQUILIBRIUM_POINT** = ``9``
  640. .. container:: contribute
  641. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  642. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_LOWER_LIMIT:
  643. .. rst-class:: classref-enumeration-constant
  644. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_LOWER_LIMIT** = ``10``
  645. The minimum rotation in negative direction to break loose and rotate around the axes.
  646. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_UPPER_LIMIT:
  647. .. rst-class:: classref-enumeration-constant
  648. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_UPPER_LIMIT** = ``11``
  649. The minimum rotation in positive direction to break loose and rotate around the axes.
  650. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS:
  651. .. rst-class:: classref-enumeration-constant
  652. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS** = ``12``
  653. A factor that gets multiplied onto all rotations across the axes.
  654. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_DAMPING:
  655. .. rst-class:: classref-enumeration-constant
  656. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_DAMPING** = ``13``
  657. The amount of rotational damping across the axes. The lower, the more damping occurs.
  658. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_RESTITUTION:
  659. .. rst-class:: classref-enumeration-constant
  660. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_RESTITUTION** = ``14``
  661. The amount of rotational restitution across the axes. The lower, the more restitution occurs.
  662. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_FORCE_LIMIT:
  663. .. rst-class:: classref-enumeration-constant
  664. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_FORCE_LIMIT** = ``15``
  665. The maximum amount of force that can occur, when rotating around the axes.
  666. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_ERP:
  667. .. rst-class:: classref-enumeration-constant
  668. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_ERP** = ``16``
  669. When correcting the crossing of limits in rotation across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
  670. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY:
  671. .. rst-class:: classref-enumeration-constant
  672. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY** = ``17``
  673. Target speed for the motor at the axes.
  674. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT:
  675. .. rst-class:: classref-enumeration-constant
  676. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT** = ``18``
  677. Maximum acceleration for the motor at the axes.
  678. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_SPRING_STIFFNESS:
  679. .. rst-class:: classref-enumeration-constant
  680. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_SPRING_STIFFNESS** = ``19``
  681. .. container:: contribute
  682. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  683. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_SPRING_DAMPING:
  684. .. rst-class:: classref-enumeration-constant
  685. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_SPRING_DAMPING** = ``20``
  686. .. container:: contribute
  687. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  688. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_SPRING_EQUILIBRIUM_POINT:
  689. .. rst-class:: classref-enumeration-constant
  690. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_SPRING_EQUILIBRIUM_POINT** = ``21``
  691. .. container:: contribute
  692. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  693. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_MAX:
  694. .. rst-class:: classref-enumeration-constant
  695. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_MAX** = ``22``
  696. Represents the size of the :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` enum.
  697. .. rst-class:: classref-item-separator
  698. ----
  699. .. _enum_PhysicsServer3D_G6DOFJointAxisFlag:
  700. .. rst-class:: classref-enumeration
  701. enum **G6DOFJointAxisFlag**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_G6DOFJointAxisFlag>`
  702. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT:
  703. .. rst-class:: classref-enumeration-constant
  704. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT** = ``0``
  705. If set, linear motion is possible within the given limits.
  706. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT:
  707. .. rst-class:: classref-enumeration-constant
  708. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT** = ``1``
  709. If set, rotational motion is possible.
  710. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_ANGULAR_SPRING:
  711. .. rst-class:: classref-enumeration-constant
  712. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_ANGULAR_SPRING** = ``2``
  713. .. container:: contribute
  714. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  715. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_LINEAR_SPRING:
  716. .. rst-class:: classref-enumeration-constant
  717. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_LINEAR_SPRING** = ``3``
  718. .. container:: contribute
  719. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  720. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_MOTOR:
  721. .. rst-class:: classref-enumeration-constant
  722. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_MOTOR** = ``4``
  723. If set, there is a rotational motor across these axes.
  724. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR:
  725. .. rst-class:: classref-enumeration-constant
  726. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR** = ``5``
  727. If set, there is a linear motor on this axis that targets a specific velocity.
  728. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_MAX:
  729. .. rst-class:: classref-enumeration-constant
  730. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_MAX** = ``6``
  731. Represents the size of the :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` enum.
  732. .. rst-class:: classref-item-separator
  733. ----
  734. .. _enum_PhysicsServer3D_ShapeType:
  735. .. rst-class:: classref-enumeration
  736. enum **ShapeType**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_ShapeType>`
  737. .. _class_PhysicsServer3D_constant_SHAPE_WORLD_BOUNDARY:
  738. .. rst-class:: classref-enumeration-constant
  739. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_WORLD_BOUNDARY** = ``0``
  740. The :ref:`Shape3D<class_Shape3D>` is a :ref:`WorldBoundaryShape3D<class_WorldBoundaryShape3D>`.
  741. .. _class_PhysicsServer3D_constant_SHAPE_SEPARATION_RAY:
  742. .. rst-class:: classref-enumeration-constant
  743. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_SEPARATION_RAY** = ``1``
  744. The :ref:`Shape3D<class_Shape3D>` is a :ref:`SeparationRayShape3D<class_SeparationRayShape3D>`.
  745. .. _class_PhysicsServer3D_constant_SHAPE_SPHERE:
  746. .. rst-class:: classref-enumeration-constant
  747. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_SPHERE** = ``2``
  748. The :ref:`Shape3D<class_Shape3D>` is a :ref:`SphereShape3D<class_SphereShape3D>`.
  749. .. _class_PhysicsServer3D_constant_SHAPE_BOX:
  750. .. rst-class:: classref-enumeration-constant
  751. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_BOX** = ``3``
  752. The :ref:`Shape3D<class_Shape3D>` is a :ref:`BoxShape3D<class_BoxShape3D>`.
  753. .. _class_PhysicsServer3D_constant_SHAPE_CAPSULE:
  754. .. rst-class:: classref-enumeration-constant
  755. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_CAPSULE** = ``4``
  756. The :ref:`Shape3D<class_Shape3D>` is a :ref:`CapsuleShape3D<class_CapsuleShape3D>`.
  757. .. _class_PhysicsServer3D_constant_SHAPE_CYLINDER:
  758. .. rst-class:: classref-enumeration-constant
  759. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_CYLINDER** = ``5``
  760. The :ref:`Shape3D<class_Shape3D>` is a :ref:`CylinderShape3D<class_CylinderShape3D>`.
  761. .. _class_PhysicsServer3D_constant_SHAPE_CONVEX_POLYGON:
  762. .. rst-class:: classref-enumeration-constant
  763. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_CONVEX_POLYGON** = ``6``
  764. The :ref:`Shape3D<class_Shape3D>` is a :ref:`ConvexPolygonShape3D<class_ConvexPolygonShape3D>`.
  765. .. _class_PhysicsServer3D_constant_SHAPE_CONCAVE_POLYGON:
  766. .. rst-class:: classref-enumeration-constant
  767. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_CONCAVE_POLYGON** = ``7``
  768. The :ref:`Shape3D<class_Shape3D>` is a :ref:`ConcavePolygonShape3D<class_ConcavePolygonShape3D>`.
  769. .. _class_PhysicsServer3D_constant_SHAPE_HEIGHTMAP:
  770. .. rst-class:: classref-enumeration-constant
  771. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_HEIGHTMAP** = ``8``
  772. The :ref:`Shape3D<class_Shape3D>` is a :ref:`HeightMapShape3D<class_HeightMapShape3D>`.
  773. .. _class_PhysicsServer3D_constant_SHAPE_SOFT_BODY:
  774. .. rst-class:: classref-enumeration-constant
  775. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_SOFT_BODY** = ``9``
  776. The :ref:`Shape3D<class_Shape3D>` is used internally for a soft body. Any attempt to create this kind of shape results in an error.
  777. .. _class_PhysicsServer3D_constant_SHAPE_CUSTOM:
  778. .. rst-class:: classref-enumeration-constant
  779. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_CUSTOM** = ``10``
  780. This constant is used internally by the engine. Any attempt to create this kind of shape results in an error.
  781. .. rst-class:: classref-item-separator
  782. ----
  783. .. _enum_PhysicsServer3D_AreaParameter:
  784. .. rst-class:: classref-enumeration
  785. enum **AreaParameter**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_AreaParameter>`
  786. .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_OVERRIDE_MODE:
  787. .. rst-class:: classref-enumeration-constant
  788. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY_OVERRIDE_MODE** = ``0``
  789. Constant to set/get gravity override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` for possible values.
  790. .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY:
  791. .. rst-class:: classref-enumeration-constant
  792. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY** = ``1``
  793. Constant to set/get gravity strength in an area.
  794. .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_VECTOR:
  795. .. rst-class:: classref-enumeration-constant
  796. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY_VECTOR** = ``2``
  797. Constant to set/get gravity vector/center in an area.
  798. .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_IS_POINT:
  799. .. rst-class:: classref-enumeration-constant
  800. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY_IS_POINT** = ``3``
  801. Constant to set/get whether the gravity vector of an area is a direction, or a center point.
  802. .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_POINT_UNIT_DISTANCE:
  803. .. rst-class:: classref-enumeration-constant
  804. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY_POINT_UNIT_DISTANCE** = ``4``
  805. Constant to set/get the distance at which the gravity strength is equal to the gravity controlled by :ref:`AREA_PARAM_GRAVITY<class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY>`. For example, on a planet 100 meters in radius with a surface gravity of 4.0 m/sยฒ, set the gravity to 4.0 and the unit distance to 100.0. The gravity will have falloff according to the inverse square law, so in the example, at 200 meters from the center the gravity will be 1.0 m/sยฒ (twice the distance, 1/4th the gravity), at 50 meters it will be 16.0 m/sยฒ (half the distance, 4x the gravity), and so on.
  806. The above is true only when the unit distance is a positive number. When this is set to 0.0, the gravity will be constant regardless of distance.
  807. .. _class_PhysicsServer3D_constant_AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE:
  808. .. rst-class:: classref-enumeration-constant
  809. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE** = ``5``
  810. Constant to set/get linear damping override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` for possible values.
  811. .. _class_PhysicsServer3D_constant_AREA_PARAM_LINEAR_DAMP:
  812. .. rst-class:: classref-enumeration-constant
  813. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_LINEAR_DAMP** = ``6``
  814. Constant to set/get the linear damping factor of an area.
  815. .. _class_PhysicsServer3D_constant_AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE:
  816. .. rst-class:: classref-enumeration-constant
  817. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE** = ``7``
  818. Constant to set/get angular damping override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` for possible values.
  819. .. _class_PhysicsServer3D_constant_AREA_PARAM_ANGULAR_DAMP:
  820. .. rst-class:: classref-enumeration-constant
  821. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_ANGULAR_DAMP** = ``8``
  822. Constant to set/get the angular damping factor of an area.
  823. .. _class_PhysicsServer3D_constant_AREA_PARAM_PRIORITY:
  824. .. rst-class:: classref-enumeration-constant
  825. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_PRIORITY** = ``9``
  826. Constant to set/get the priority (order of processing) of an area.
  827. .. _class_PhysicsServer3D_constant_AREA_PARAM_WIND_FORCE_MAGNITUDE:
  828. .. rst-class:: classref-enumeration-constant
  829. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_FORCE_MAGNITUDE** = ``10``
  830. Constant to set/get the magnitude of area-specific wind force. This wind force only applies to :ref:`SoftBody3D<class_SoftBody3D>` nodes. Other physics bodies are currently not affected by wind.
  831. .. _class_PhysicsServer3D_constant_AREA_PARAM_WIND_SOURCE:
  832. .. rst-class:: classref-enumeration-constant
  833. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_SOURCE** = ``11``
  834. Constant to set/get the 3D vector that specifies the origin from which an area-specific wind blows.
  835. .. _class_PhysicsServer3D_constant_AREA_PARAM_WIND_DIRECTION:
  836. .. rst-class:: classref-enumeration-constant
  837. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_DIRECTION** = ``12``
  838. Constant to set/get the 3D vector that specifies the direction in which an area-specific wind blows.
  839. .. _class_PhysicsServer3D_constant_AREA_PARAM_WIND_ATTENUATION_FACTOR:
  840. .. rst-class:: classref-enumeration-constant
  841. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_ATTENUATION_FACTOR** = ``13``
  842. Constant to set/get the exponential rate at which wind force decreases with distance from its origin.
  843. .. rst-class:: classref-item-separator
  844. ----
  845. .. _enum_PhysicsServer3D_AreaSpaceOverrideMode:
  846. .. rst-class:: classref-enumeration
  847. enum **AreaSpaceOverrideMode**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_AreaSpaceOverrideMode>`
  848. .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_DISABLED:
  849. .. rst-class:: classref-enumeration-constant
  850. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_DISABLED** = ``0``
  851. This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
  852. .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_COMBINE:
  853. .. rst-class:: classref-enumeration-constant
  854. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_COMBINE** = ``1``
  855. 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.
  856. .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_COMBINE_REPLACE:
  857. .. rst-class:: classref-enumeration-constant
  858. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_COMBINE_REPLACE** = ``2``
  859. 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.
  860. .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_REPLACE:
  861. .. rst-class:: classref-enumeration-constant
  862. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_REPLACE** = ``3``
  863. This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
  864. .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_REPLACE_COMBINE:
  865. .. rst-class:: classref-enumeration-constant
  866. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_REPLACE_COMBINE** = ``4``
  867. This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
  868. .. rst-class:: classref-item-separator
  869. ----
  870. .. _enum_PhysicsServer3D_BodyMode:
  871. .. rst-class:: classref-enumeration
  872. enum **BodyMode**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_BodyMode>`
  873. .. _class_PhysicsServer3D_constant_BODY_MODE_STATIC:
  874. .. rst-class:: classref-enumeration-constant
  875. :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **BODY_MODE_STATIC** = ``0``
  876. 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.
  877. .. _class_PhysicsServer3D_constant_BODY_MODE_KINEMATIC:
  878. .. rst-class:: classref-enumeration-constant
  879. :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **BODY_MODE_KINEMATIC** = ``1``
  880. Constant for kinematic bodies. In this mode, a body can be only moved by user code and collides with other bodies along its path.
  881. .. _class_PhysicsServer3D_constant_BODY_MODE_RIGID:
  882. .. rst-class:: classref-enumeration-constant
  883. :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **BODY_MODE_RIGID** = ``2``
  884. Constant for rigid bodies. In this mode, a body can be pushed by other bodies and has forces applied.
  885. .. _class_PhysicsServer3D_constant_BODY_MODE_RIGID_LINEAR:
  886. .. rst-class:: classref-enumeration-constant
  887. :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **BODY_MODE_RIGID_LINEAR** = ``3``
  888. Constant for linear rigid bodies. In this mode, a body can not rotate, and only its linear velocity is affected by external forces.
  889. .. rst-class:: classref-item-separator
  890. ----
  891. .. _enum_PhysicsServer3D_BodyParameter:
  892. .. rst-class:: classref-enumeration
  893. enum **BodyParameter**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_BodyParameter>`
  894. .. _class_PhysicsServer3D_constant_BODY_PARAM_BOUNCE:
  895. .. rst-class:: classref-enumeration-constant
  896. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_BOUNCE** = ``0``
  897. Constant to set/get a body's bounce factor.
  898. .. _class_PhysicsServer3D_constant_BODY_PARAM_FRICTION:
  899. .. rst-class:: classref-enumeration-constant
  900. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_FRICTION** = ``1``
  901. Constant to set/get a body's friction.
  902. .. _class_PhysicsServer3D_constant_BODY_PARAM_MASS:
  903. .. rst-class:: classref-enumeration-constant
  904. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_MASS** = ``2``
  905. Constant to set/get a body's mass.
  906. .. _class_PhysicsServer3D_constant_BODY_PARAM_INERTIA:
  907. .. rst-class:: classref-enumeration-constant
  908. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_INERTIA** = ``3``
  909. Constant to set/get a body's inertia.
  910. .. _class_PhysicsServer3D_constant_BODY_PARAM_CENTER_OF_MASS:
  911. .. rst-class:: classref-enumeration-constant
  912. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_CENTER_OF_MASS** = ``4``
  913. Constant to set/get a body's center of mass position in the body's local coordinate system.
  914. .. _class_PhysicsServer3D_constant_BODY_PARAM_GRAVITY_SCALE:
  915. .. rst-class:: classref-enumeration-constant
  916. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_GRAVITY_SCALE** = ``5``
  917. Constant to set/get a body's gravity multiplier.
  918. .. _class_PhysicsServer3D_constant_BODY_PARAM_LINEAR_DAMP_MODE:
  919. .. rst-class:: classref-enumeration-constant
  920. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_LINEAR_DAMP_MODE** = ``6``
  921. Constant to set/get a body's linear damping mode. See :ref:`BodyDampMode<enum_PhysicsServer3D_BodyDampMode>` for possible values.
  922. .. _class_PhysicsServer3D_constant_BODY_PARAM_ANGULAR_DAMP_MODE:
  923. .. rst-class:: classref-enumeration-constant
  924. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_ANGULAR_DAMP_MODE** = ``7``
  925. Constant to set/get a body's angular damping mode. See :ref:`BodyDampMode<enum_PhysicsServer3D_BodyDampMode>` for possible values.
  926. .. _class_PhysicsServer3D_constant_BODY_PARAM_LINEAR_DAMP:
  927. .. rst-class:: classref-enumeration-constant
  928. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_LINEAR_DAMP** = ``8``
  929. Constant to set/get a body's linear damping factor.
  930. .. _class_PhysicsServer3D_constant_BODY_PARAM_ANGULAR_DAMP:
  931. .. rst-class:: classref-enumeration-constant
  932. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_ANGULAR_DAMP** = ``9``
  933. Constant to set/get a body's angular damping factor.
  934. .. _class_PhysicsServer3D_constant_BODY_PARAM_MAX:
  935. .. rst-class:: classref-enumeration-constant
  936. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_MAX** = ``10``
  937. Represents the size of the :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` enum.
  938. .. rst-class:: classref-item-separator
  939. ----
  940. .. _enum_PhysicsServer3D_BodyDampMode:
  941. .. rst-class:: classref-enumeration
  942. enum **BodyDampMode**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_BodyDampMode>`
  943. .. _class_PhysicsServer3D_constant_BODY_DAMP_MODE_COMBINE:
  944. .. rst-class:: classref-enumeration-constant
  945. :ref:`BodyDampMode<enum_PhysicsServer3D_BodyDampMode>` **BODY_DAMP_MODE_COMBINE** = ``0``
  946. The body's damping value is added to any value set in areas or the default value.
  947. .. _class_PhysicsServer3D_constant_BODY_DAMP_MODE_REPLACE:
  948. .. rst-class:: classref-enumeration-constant
  949. :ref:`BodyDampMode<enum_PhysicsServer3D_BodyDampMode>` **BODY_DAMP_MODE_REPLACE** = ``1``
  950. The body's damping value replaces any value set in areas or the default value.
  951. .. rst-class:: classref-item-separator
  952. ----
  953. .. _enum_PhysicsServer3D_BodyState:
  954. .. rst-class:: classref-enumeration
  955. enum **BodyState**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_BodyState>`
  956. .. _class_PhysicsServer3D_constant_BODY_STATE_TRANSFORM:
  957. .. rst-class:: classref-enumeration-constant
  958. :ref:`BodyState<enum_PhysicsServer3D_BodyState>` **BODY_STATE_TRANSFORM** = ``0``
  959. Constant to set/get the current transform matrix of the body.
  960. .. _class_PhysicsServer3D_constant_BODY_STATE_LINEAR_VELOCITY:
  961. .. rst-class:: classref-enumeration-constant
  962. :ref:`BodyState<enum_PhysicsServer3D_BodyState>` **BODY_STATE_LINEAR_VELOCITY** = ``1``
  963. Constant to set/get the current linear velocity of the body.
  964. .. _class_PhysicsServer3D_constant_BODY_STATE_ANGULAR_VELOCITY:
  965. .. rst-class:: classref-enumeration-constant
  966. :ref:`BodyState<enum_PhysicsServer3D_BodyState>` **BODY_STATE_ANGULAR_VELOCITY** = ``2``
  967. Constant to set/get the current angular velocity of the body.
  968. .. _class_PhysicsServer3D_constant_BODY_STATE_SLEEPING:
  969. .. rst-class:: classref-enumeration-constant
  970. :ref:`BodyState<enum_PhysicsServer3D_BodyState>` **BODY_STATE_SLEEPING** = ``3``
  971. Constant to sleep/wake up a body, or to get whether it is sleeping.
  972. .. _class_PhysicsServer3D_constant_BODY_STATE_CAN_SLEEP:
  973. .. rst-class:: classref-enumeration-constant
  974. :ref:`BodyState<enum_PhysicsServer3D_BodyState>` **BODY_STATE_CAN_SLEEP** = ``4``
  975. Constant to set/get whether the body can sleep.
  976. .. rst-class:: classref-item-separator
  977. ----
  978. .. _enum_PhysicsServer3D_AreaBodyStatus:
  979. .. rst-class:: classref-enumeration
  980. enum **AreaBodyStatus**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_AreaBodyStatus>`
  981. .. _class_PhysicsServer3D_constant_AREA_BODY_ADDED:
  982. .. rst-class:: classref-enumeration-constant
  983. :ref:`AreaBodyStatus<enum_PhysicsServer3D_AreaBodyStatus>` **AREA_BODY_ADDED** = ``0``
  984. The value of the first parameter and area callback function receives, when an object enters one of its shapes.
  985. .. _class_PhysicsServer3D_constant_AREA_BODY_REMOVED:
  986. .. rst-class:: classref-enumeration-constant
  987. :ref:`AreaBodyStatus<enum_PhysicsServer3D_AreaBodyStatus>` **AREA_BODY_REMOVED** = ``1``
  988. The value of the first parameter and area callback function receives, when an object exits one of its shapes.
  989. .. rst-class:: classref-item-separator
  990. ----
  991. .. _enum_PhysicsServer3D_ProcessInfo:
  992. .. rst-class:: classref-enumeration
  993. enum **ProcessInfo**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_ProcessInfo>`
  994. .. _class_PhysicsServer3D_constant_INFO_ACTIVE_OBJECTS:
  995. .. rst-class:: classref-enumeration-constant
  996. :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>` **INFO_ACTIVE_OBJECTS** = ``0``
  997. Constant to get the number of objects that are not sleeping.
  998. .. _class_PhysicsServer3D_constant_INFO_COLLISION_PAIRS:
  999. .. rst-class:: classref-enumeration-constant
  1000. :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>` **INFO_COLLISION_PAIRS** = ``1``
  1001. Constant to get the number of possible collisions.
  1002. .. _class_PhysicsServer3D_constant_INFO_ISLAND_COUNT:
  1003. .. rst-class:: classref-enumeration-constant
  1004. :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>` **INFO_ISLAND_COUNT** = ``2``
  1005. Constant to get the number of space regions where a collision could occur.
  1006. .. rst-class:: classref-item-separator
  1007. ----
  1008. .. _enum_PhysicsServer3D_SpaceParameter:
  1009. .. rst-class:: classref-enumeration
  1010. enum **SpaceParameter**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_SpaceParameter>`
  1011. .. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_RECYCLE_RADIUS:
  1012. .. rst-class:: classref-enumeration-constant
  1013. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_CONTACT_RECYCLE_RADIUS** = ``0``
  1014. Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated.
  1015. .. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_MAX_SEPARATION:
  1016. .. rst-class:: classref-enumeration-constant
  1017. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_CONTACT_MAX_SEPARATION** = ``1``
  1018. Constant to set/get the maximum distance a shape can be from another before they are considered separated and the contact is discarded.
  1019. .. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION:
  1020. .. rst-class:: classref-enumeration-constant
  1021. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION** = ``2``
  1022. Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision.
  1023. .. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_DEFAULT_BIAS:
  1024. .. rst-class:: classref-enumeration-constant
  1025. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_CONTACT_DEFAULT_BIAS** = ``3``
  1026. 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.
  1027. .. _class_PhysicsServer3D_constant_SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD:
  1028. .. rst-class:: classref-enumeration-constant
  1029. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD** = ``4``
  1030. 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.
  1031. .. _class_PhysicsServer3D_constant_SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD:
  1032. .. rst-class:: classref-enumeration-constant
  1033. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD** = ``5``
  1034. 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.
  1035. .. _class_PhysicsServer3D_constant_SPACE_PARAM_BODY_TIME_TO_SLEEP:
  1036. .. rst-class:: classref-enumeration-constant
  1037. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_BODY_TIME_TO_SLEEP** = ``6``
  1038. 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.
  1039. .. _class_PhysicsServer3D_constant_SPACE_PARAM_SOLVER_ITERATIONS:
  1040. .. rst-class:: classref-enumeration-constant
  1041. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_SOLVER_ITERATIONS** = ``7``
  1042. Constant to set/get the number of solver iterations for contacts and constraints. The greater the number of iterations, the more accurate the collisions and constraints will be. However, a greater number of iterations requires more CPU power, which can decrease performance.
  1043. .. rst-class:: classref-item-separator
  1044. ----
  1045. .. _enum_PhysicsServer3D_BodyAxis:
  1046. .. rst-class:: classref-enumeration
  1047. enum **BodyAxis**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_BodyAxis>`
  1048. .. _class_PhysicsServer3D_constant_BODY_AXIS_LINEAR_X:
  1049. .. rst-class:: classref-enumeration-constant
  1050. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_LINEAR_X** = ``1``
  1051. .. container:: contribute
  1052. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1053. .. _class_PhysicsServer3D_constant_BODY_AXIS_LINEAR_Y:
  1054. .. rst-class:: classref-enumeration-constant
  1055. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_LINEAR_Y** = ``2``
  1056. .. container:: contribute
  1057. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1058. .. _class_PhysicsServer3D_constant_BODY_AXIS_LINEAR_Z:
  1059. .. rst-class:: classref-enumeration-constant
  1060. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_LINEAR_Z** = ``4``
  1061. .. container:: contribute
  1062. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1063. .. _class_PhysicsServer3D_constant_BODY_AXIS_ANGULAR_X:
  1064. .. rst-class:: classref-enumeration-constant
  1065. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_ANGULAR_X** = ``8``
  1066. .. container:: contribute
  1067. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1068. .. _class_PhysicsServer3D_constant_BODY_AXIS_ANGULAR_Y:
  1069. .. rst-class:: classref-enumeration-constant
  1070. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_ANGULAR_Y** = ``16``
  1071. .. container:: contribute
  1072. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1073. .. _class_PhysicsServer3D_constant_BODY_AXIS_ANGULAR_Z:
  1074. .. rst-class:: classref-enumeration-constant
  1075. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_ANGULAR_Z** = ``32``
  1076. .. container:: contribute
  1077. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1078. .. rst-class:: classref-section-separator
  1079. ----
  1080. .. rst-class:: classref-descriptions-group
  1081. Method Descriptions
  1082. -------------------
  1083. .. _class_PhysicsServer3D_method_area_add_shape:
  1084. .. rst-class:: classref-method
  1085. |void| **area_add_shape**\ (\ area\: :ref:`RID<class_RID>`, shape\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>` = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), disabled\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_add_shape>`
  1086. 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.
  1087. .. rst-class:: classref-item-separator
  1088. ----
  1089. .. _class_PhysicsServer3D_method_area_attach_object_instance_id:
  1090. .. rst-class:: classref-method
  1091. |void| **area_attach_object_instance_id**\ (\ area\: :ref:`RID<class_RID>`, id\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_attach_object_instance_id>`
  1092. Assigns the area to a descendant of :ref:`Object<class_Object>`, so it can exist in the node tree.
  1093. .. rst-class:: classref-item-separator
  1094. ----
  1095. .. _class_PhysicsServer3D_method_area_clear_shapes:
  1096. .. rst-class:: classref-method
  1097. |void| **area_clear_shapes**\ (\ area\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_clear_shapes>`
  1098. Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later.
  1099. .. rst-class:: classref-item-separator
  1100. ----
  1101. .. _class_PhysicsServer3D_method_area_create:
  1102. .. rst-class:: classref-method
  1103. :ref:`RID<class_RID>` **area_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_create>`
  1104. Creates a 3D area object in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. The default settings for the created area include a collision layer and mask set to ``1``, and ``monitorable`` set to ``false``.
  1105. Use :ref:`area_add_shape<class_PhysicsServer3D_method_area_add_shape>` to add shapes to it, use :ref:`area_set_transform<class_PhysicsServer3D_method_area_set_transform>` to set its transform, and use :ref:`area_set_space<class_PhysicsServer3D_method_area_set_space>` to add the area to a space. If you want the area to be detectable use :ref:`area_set_monitorable<class_PhysicsServer3D_method_area_set_monitorable>`.
  1106. .. rst-class:: classref-item-separator
  1107. ----
  1108. .. _class_PhysicsServer3D_method_area_get_collision_layer:
  1109. .. rst-class:: classref-method
  1110. :ref:`int<class_int>` **area_get_collision_layer**\ (\ area\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_get_collision_layer>`
  1111. Returns the physics layer or layers an area belongs to.
  1112. .. rst-class:: classref-item-separator
  1113. ----
  1114. .. _class_PhysicsServer3D_method_area_get_collision_mask:
  1115. .. rst-class:: classref-method
  1116. :ref:`int<class_int>` **area_get_collision_mask**\ (\ area\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_get_collision_mask>`
  1117. Returns the physics layer or layers an area can contact with.
  1118. .. rst-class:: classref-item-separator
  1119. ----
  1120. .. _class_PhysicsServer3D_method_area_get_object_instance_id:
  1121. .. rst-class:: classref-method
  1122. :ref:`int<class_int>` **area_get_object_instance_id**\ (\ area\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_get_object_instance_id>`
  1123. Gets the instance ID of the object the area is assigned to.
  1124. .. rst-class:: classref-item-separator
  1125. ----
  1126. .. _class_PhysicsServer3D_method_area_get_param:
  1127. .. rst-class:: classref-method
  1128. :ref:`Variant<class_Variant>` **area_get_param**\ (\ area\: :ref:`RID<class_RID>`, param\: :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_get_param>`
  1129. Returns an area parameter value. A list of available parameters is on the :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` constants.
  1130. .. rst-class:: classref-item-separator
  1131. ----
  1132. .. _class_PhysicsServer3D_method_area_get_shape:
  1133. .. rst-class:: classref-method
  1134. :ref:`RID<class_RID>` **area_get_shape**\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_get_shape>`
  1135. Returns the :ref:`RID<class_RID>` of the nth shape of an area.
  1136. .. rst-class:: classref-item-separator
  1137. ----
  1138. .. _class_PhysicsServer3D_method_area_get_shape_count:
  1139. .. rst-class:: classref-method
  1140. :ref:`int<class_int>` **area_get_shape_count**\ (\ area\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_get_shape_count>`
  1141. Returns the number of shapes assigned to an area.
  1142. .. rst-class:: classref-item-separator
  1143. ----
  1144. .. _class_PhysicsServer3D_method_area_get_shape_transform:
  1145. .. rst-class:: classref-method
  1146. :ref:`Transform3D<class_Transform3D>` **area_get_shape_transform**\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_get_shape_transform>`
  1147. Returns the transform matrix of a shape within an area.
  1148. .. rst-class:: classref-item-separator
  1149. ----
  1150. .. _class_PhysicsServer3D_method_area_get_space:
  1151. .. rst-class:: classref-method
  1152. :ref:`RID<class_RID>` **area_get_space**\ (\ area\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_get_space>`
  1153. Returns the space assigned to the area.
  1154. .. rst-class:: classref-item-separator
  1155. ----
  1156. .. _class_PhysicsServer3D_method_area_get_transform:
  1157. .. rst-class:: classref-method
  1158. :ref:`Transform3D<class_Transform3D>` **area_get_transform**\ (\ area\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_get_transform>`
  1159. Returns the transform matrix for an area.
  1160. .. rst-class:: classref-item-separator
  1161. ----
  1162. .. _class_PhysicsServer3D_method_area_remove_shape:
  1163. .. rst-class:: classref-method
  1164. |void| **area_remove_shape**\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_remove_shape>`
  1165. Removes a shape from an area. It does not delete the shape, so it can be reassigned later.
  1166. .. rst-class:: classref-item-separator
  1167. ----
  1168. .. _class_PhysicsServer3D_method_area_set_area_monitor_callback:
  1169. .. rst-class:: classref-method
  1170. |void| **area_set_area_monitor_callback**\ (\ area\: :ref:`RID<class_RID>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_set_area_monitor_callback>`
  1171. Sets the area's area monitor callback. This callback will be called when any other (shape of an) area enters or exits (a shape of) the given area, and must take the following five parameters:
  1172. 1. an integer ``status``: either :ref:`AREA_BODY_ADDED<class_PhysicsServer3D_constant_AREA_BODY_ADDED>` or :ref:`AREA_BODY_REMOVED<class_PhysicsServer3D_constant_AREA_BODY_REMOVED>` depending on whether the other area's shape entered or exited the area,
  1173. 2. an :ref:`RID<class_RID>` ``area_rid``: the :ref:`RID<class_RID>` of the other area that entered or exited the area,
  1174. 3. an integer ``instance_id``: the ``ObjectID`` attached to the other area,
  1175. 4. an integer ``area_shape_idx``: the index of the shape of the other area that entered or exited the area,
  1176. 5. an integer ``self_shape_idx``: the index of the shape of the area where the other area entered or exited.
  1177. By counting (or keeping track of) the shapes that enter and exit, it can be determined if an area (with all its shapes) is entering for the first time or exiting for the last time.
  1178. .. rst-class:: classref-item-separator
  1179. ----
  1180. .. _class_PhysicsServer3D_method_area_set_collision_layer:
  1181. .. rst-class:: classref-method
  1182. |void| **area_set_collision_layer**\ (\ area\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_set_collision_layer>`
  1183. Assigns the area to one or many physics layers.
  1184. .. rst-class:: classref-item-separator
  1185. ----
  1186. .. _class_PhysicsServer3D_method_area_set_collision_mask:
  1187. .. rst-class:: classref-method
  1188. |void| **area_set_collision_mask**\ (\ area\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_set_collision_mask>`
  1189. Sets which physics layers the area will monitor.
  1190. .. rst-class:: classref-item-separator
  1191. ----
  1192. .. _class_PhysicsServer3D_method_area_set_monitor_callback:
  1193. .. rst-class:: classref-method
  1194. |void| **area_set_monitor_callback**\ (\ area\: :ref:`RID<class_RID>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_set_monitor_callback>`
  1195. Sets the area's body monitor callback. This callback will be called when any other (shape of a) body enters or exits (a shape of) the given area, and must take the following five parameters:
  1196. 1. an integer ``status``: either :ref:`AREA_BODY_ADDED<class_PhysicsServer3D_constant_AREA_BODY_ADDED>` or :ref:`AREA_BODY_REMOVED<class_PhysicsServer3D_constant_AREA_BODY_REMOVED>` depending on whether the other body shape entered or exited the area,
  1197. 2. an :ref:`RID<class_RID>` ``body_rid``: the :ref:`RID<class_RID>` of the body that entered or exited the area,
  1198. 3. an integer ``instance_id``: the ``ObjectID`` attached to the body,
  1199. 4. an integer ``body_shape_idx``: the index of the shape of the body that entered or exited the area,
  1200. 5. an integer ``self_shape_idx``: the index of the shape of the area where the body entered or exited.
  1201. By counting (or keeping track of) the shapes that enter and exit, it can be determined if a body (with all its shapes) is entering for the first time or exiting for the last time.
  1202. .. rst-class:: classref-item-separator
  1203. ----
  1204. .. _class_PhysicsServer3D_method_area_set_monitorable:
  1205. .. rst-class:: classref-method
  1206. |void| **area_set_monitorable**\ (\ area\: :ref:`RID<class_RID>`, monitorable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_set_monitorable>`
  1207. .. container:: contribute
  1208. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1209. .. rst-class:: classref-item-separator
  1210. ----
  1211. .. _class_PhysicsServer3D_method_area_set_param:
  1212. .. rst-class:: classref-method
  1213. |void| **area_set_param**\ (\ area\: :ref:`RID<class_RID>`, param\: :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_set_param>`
  1214. Sets the value for an area parameter. A list of available parameters is on the :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` constants.
  1215. .. rst-class:: classref-item-separator
  1216. ----
  1217. .. _class_PhysicsServer3D_method_area_set_ray_pickable:
  1218. .. rst-class:: classref-method
  1219. |void| **area_set_ray_pickable**\ (\ area\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_set_ray_pickable>`
  1220. Sets object pickable with rays.
  1221. .. rst-class:: classref-item-separator
  1222. ----
  1223. .. _class_PhysicsServer3D_method_area_set_shape:
  1224. .. rst-class:: classref-method
  1225. |void| **area_set_shape**\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, shape\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_set_shape>`
  1226. Substitutes a given area shape by another. The old shape is selected by its index, the new one by its :ref:`RID<class_RID>`.
  1227. .. rst-class:: classref-item-separator
  1228. ----
  1229. .. _class_PhysicsServer3D_method_area_set_shape_disabled:
  1230. .. rst-class:: classref-method
  1231. |void| **area_set_shape_disabled**\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_set_shape_disabled>`
  1232. .. container:: contribute
  1233. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1234. .. rst-class:: classref-item-separator
  1235. ----
  1236. .. _class_PhysicsServer3D_method_area_set_shape_transform:
  1237. .. rst-class:: classref-method
  1238. |void| **area_set_shape_transform**\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_set_shape_transform>`
  1239. Sets the transform matrix for an area shape.
  1240. .. rst-class:: classref-item-separator
  1241. ----
  1242. .. _class_PhysicsServer3D_method_area_set_space:
  1243. .. rst-class:: classref-method
  1244. |void| **area_set_space**\ (\ area\: :ref:`RID<class_RID>`, space\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_set_space>`
  1245. Assigns a space to the area.
  1246. .. rst-class:: classref-item-separator
  1247. ----
  1248. .. _class_PhysicsServer3D_method_area_set_transform:
  1249. .. rst-class:: classref-method
  1250. |void| **area_set_transform**\ (\ area\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_set_transform>`
  1251. Sets the transform matrix for an area.
  1252. .. rst-class:: classref-item-separator
  1253. ----
  1254. .. _class_PhysicsServer3D_method_body_add_collision_exception:
  1255. .. rst-class:: classref-method
  1256. |void| **body_add_collision_exception**\ (\ body\: :ref:`RID<class_RID>`, excepted_body\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_add_collision_exception>`
  1257. Adds a body to the list of bodies exempt from collisions.
  1258. .. rst-class:: classref-item-separator
  1259. ----
  1260. .. _class_PhysicsServer3D_method_body_add_constant_central_force:
  1261. .. rst-class:: classref-method
  1262. |void| **body_add_constant_central_force**\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_add_constant_central_force>`
  1263. Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with ``body_set_constant_force(body, Vector3(0, 0, 0))``.
  1264. This is equivalent to using :ref:`body_add_constant_force<class_PhysicsServer3D_method_body_add_constant_force>` at the body's center of mass.
  1265. .. rst-class:: classref-item-separator
  1266. ----
  1267. .. _class_PhysicsServer3D_method_body_add_constant_force:
  1268. .. rst-class:: classref-method
  1269. |void| **body_add_constant_force**\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_add_constant_force>`
  1270. Adds a constant positioned force to the body that keeps being applied over time until cleared with ``body_set_constant_force(body, Vector3(0, 0, 0))``.
  1271. \ ``position`` is the offset from the body origin in global coordinates.
  1272. .. rst-class:: classref-item-separator
  1273. ----
  1274. .. _class_PhysicsServer3D_method_body_add_constant_torque:
  1275. .. rst-class:: classref-method
  1276. |void| **body_add_constant_torque**\ (\ body\: :ref:`RID<class_RID>`, torque\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_add_constant_torque>`
  1277. Adds a constant rotational force without affecting position that keeps being applied over time until cleared with ``body_set_constant_torque(body, Vector3(0, 0, 0))``.
  1278. .. rst-class:: classref-item-separator
  1279. ----
  1280. .. _class_PhysicsServer3D_method_body_add_shape:
  1281. .. rst-class:: classref-method
  1282. |void| **body_add_shape**\ (\ body\: :ref:`RID<class_RID>`, shape\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>` = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), disabled\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_add_shape>`
  1283. 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.
  1284. .. rst-class:: classref-item-separator
  1285. ----
  1286. .. _class_PhysicsServer3D_method_body_apply_central_force:
  1287. .. rst-class:: classref-method
  1288. |void| **body_apply_central_force**\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_apply_central_force>`
  1289. Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update.
  1290. This is equivalent to using :ref:`body_apply_force<class_PhysicsServer3D_method_body_apply_force>` at the body's center of mass.
  1291. .. rst-class:: classref-item-separator
  1292. ----
  1293. .. _class_PhysicsServer3D_method_body_apply_central_impulse:
  1294. .. rst-class:: classref-method
  1295. |void| **body_apply_central_impulse**\ (\ body\: :ref:`RID<class_RID>`, impulse\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_apply_central_impulse>`
  1296. Applies a directional impulse without affecting rotation.
  1297. 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).
  1298. This is equivalent to using :ref:`body_apply_impulse<class_PhysicsServer3D_method_body_apply_impulse>` at the body's center of mass.
  1299. .. rst-class:: classref-item-separator
  1300. ----
  1301. .. _class_PhysicsServer3D_method_body_apply_force:
  1302. .. rst-class:: classref-method
  1303. |void| **body_apply_force**\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_apply_force>`
  1304. Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update.
  1305. \ ``position`` is the offset from the body origin in global coordinates.
  1306. .. rst-class:: classref-item-separator
  1307. ----
  1308. .. _class_PhysicsServer3D_method_body_apply_impulse:
  1309. .. rst-class:: classref-method
  1310. |void| **body_apply_impulse**\ (\ body\: :ref:`RID<class_RID>`, impulse\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_apply_impulse>`
  1311. Applies a positioned impulse to the body.
  1312. 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).
  1313. \ ``position`` is the offset from the body origin in global coordinates.
  1314. .. rst-class:: classref-item-separator
  1315. ----
  1316. .. _class_PhysicsServer3D_method_body_apply_torque:
  1317. .. rst-class:: classref-method
  1318. |void| **body_apply_torque**\ (\ body\: :ref:`RID<class_RID>`, torque\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_apply_torque>`
  1319. Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update.
  1320. .. rst-class:: classref-item-separator
  1321. ----
  1322. .. _class_PhysicsServer3D_method_body_apply_torque_impulse:
  1323. .. rst-class:: classref-method
  1324. |void| **body_apply_torque_impulse**\ (\ body\: :ref:`RID<class_RID>`, impulse\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_apply_torque_impulse>`
  1325. Applies a rotational impulse to the body without affecting the position.
  1326. 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).
  1327. .. rst-class:: classref-item-separator
  1328. ----
  1329. .. _class_PhysicsServer3D_method_body_attach_object_instance_id:
  1330. .. rst-class:: classref-method
  1331. |void| **body_attach_object_instance_id**\ (\ body\: :ref:`RID<class_RID>`, id\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_attach_object_instance_id>`
  1332. Assigns the area to a descendant of :ref:`Object<class_Object>`, so it can exist in the node tree.
  1333. .. rst-class:: classref-item-separator
  1334. ----
  1335. .. _class_PhysicsServer3D_method_body_clear_shapes:
  1336. .. rst-class:: classref-method
  1337. |void| **body_clear_shapes**\ (\ body\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_clear_shapes>`
  1338. Removes all shapes from a body.
  1339. .. rst-class:: classref-item-separator
  1340. ----
  1341. .. _class_PhysicsServer3D_method_body_create:
  1342. .. rst-class:: classref-method
  1343. :ref:`RID<class_RID>` **body_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_create>`
  1344. Creates a 3D body object in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. The default settings for the created area include a collision layer and mask set to ``1``, and body mode set to :ref:`BODY_MODE_RIGID<class_PhysicsServer3D_constant_BODY_MODE_RIGID>`.
  1345. Use :ref:`body_add_shape<class_PhysicsServer3D_method_body_add_shape>` to add shapes to it, use :ref:`body_set_state<class_PhysicsServer3D_method_body_set_state>` to set its transform, and use :ref:`body_set_space<class_PhysicsServer3D_method_body_set_space>` to add the body to a space.
  1346. .. rst-class:: classref-item-separator
  1347. ----
  1348. .. _class_PhysicsServer3D_method_body_get_collision_layer:
  1349. .. rst-class:: classref-method
  1350. :ref:`int<class_int>` **body_get_collision_layer**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_collision_layer>`
  1351. Returns the physics layer or layers a body belongs to.
  1352. .. rst-class:: classref-item-separator
  1353. ----
  1354. .. _class_PhysicsServer3D_method_body_get_collision_mask:
  1355. .. rst-class:: classref-method
  1356. :ref:`int<class_int>` **body_get_collision_mask**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_collision_mask>`
  1357. Returns the physics layer or layers a body can collide with.
  1358. .. rst-class:: classref-item-separator
  1359. ----
  1360. .. _class_PhysicsServer3D_method_body_get_collision_priority:
  1361. .. rst-class:: classref-method
  1362. :ref:`float<class_float>` **body_get_collision_priority**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_collision_priority>`
  1363. Returns the body's collision priority.
  1364. .. rst-class:: classref-item-separator
  1365. ----
  1366. .. _class_PhysicsServer3D_method_body_get_constant_force:
  1367. .. rst-class:: classref-method
  1368. :ref:`Vector3<class_Vector3>` **body_get_constant_force**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_constant_force>`
  1369. Returns the body's total constant positional forces applied during each physics update.
  1370. See :ref:`body_add_constant_force<class_PhysicsServer3D_method_body_add_constant_force>` and :ref:`body_add_constant_central_force<class_PhysicsServer3D_method_body_add_constant_central_force>`.
  1371. .. rst-class:: classref-item-separator
  1372. ----
  1373. .. _class_PhysicsServer3D_method_body_get_constant_torque:
  1374. .. rst-class:: classref-method
  1375. :ref:`Vector3<class_Vector3>` **body_get_constant_torque**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_constant_torque>`
  1376. Returns the body's total constant rotational forces applied during each physics update.
  1377. See :ref:`body_add_constant_torque<class_PhysicsServer3D_method_body_add_constant_torque>`.
  1378. .. rst-class:: classref-item-separator
  1379. ----
  1380. .. _class_PhysicsServer3D_method_body_get_direct_state:
  1381. .. rst-class:: classref-method
  1382. :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>` **body_get_direct_state**\ (\ body\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_direct_state>`
  1383. Returns the :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>` of the body. Returns ``null`` if the body is destroyed or removed from the physics space.
  1384. .. rst-class:: classref-item-separator
  1385. ----
  1386. .. _class_PhysicsServer3D_method_body_get_max_contacts_reported:
  1387. .. rst-class:: classref-method
  1388. :ref:`int<class_int>` **body_get_max_contacts_reported**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_max_contacts_reported>`
  1389. Returns the maximum contacts that can be reported. See :ref:`body_set_max_contacts_reported<class_PhysicsServer3D_method_body_set_max_contacts_reported>`.
  1390. .. rst-class:: classref-item-separator
  1391. ----
  1392. .. _class_PhysicsServer3D_method_body_get_mode:
  1393. .. rst-class:: classref-method
  1394. :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **body_get_mode**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_mode>`
  1395. Returns the body mode.
  1396. .. rst-class:: classref-item-separator
  1397. ----
  1398. .. _class_PhysicsServer3D_method_body_get_object_instance_id:
  1399. .. rst-class:: classref-method
  1400. :ref:`int<class_int>` **body_get_object_instance_id**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_object_instance_id>`
  1401. Gets the instance ID of the object the area is assigned to.
  1402. .. rst-class:: classref-item-separator
  1403. ----
  1404. .. _class_PhysicsServer3D_method_body_get_param:
  1405. .. rst-class:: classref-method
  1406. :ref:`Variant<class_Variant>` **body_get_param**\ (\ body\: :ref:`RID<class_RID>`, param\: :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_param>`
  1407. Returns the value of a body parameter. A list of available parameters is on the :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` constants.
  1408. .. rst-class:: classref-item-separator
  1409. ----
  1410. .. _class_PhysicsServer3D_method_body_get_shape:
  1411. .. rst-class:: classref-method
  1412. :ref:`RID<class_RID>` **body_get_shape**\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_shape>`
  1413. Returns the :ref:`RID<class_RID>` of the nth shape of a body.
  1414. .. rst-class:: classref-item-separator
  1415. ----
  1416. .. _class_PhysicsServer3D_method_body_get_shape_count:
  1417. .. rst-class:: classref-method
  1418. :ref:`int<class_int>` **body_get_shape_count**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_shape_count>`
  1419. Returns the number of shapes assigned to a body.
  1420. .. rst-class:: classref-item-separator
  1421. ----
  1422. .. _class_PhysicsServer3D_method_body_get_shape_transform:
  1423. .. rst-class:: classref-method
  1424. :ref:`Transform3D<class_Transform3D>` **body_get_shape_transform**\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_shape_transform>`
  1425. Returns the transform matrix of a body shape.
  1426. .. rst-class:: classref-item-separator
  1427. ----
  1428. .. _class_PhysicsServer3D_method_body_get_space:
  1429. .. rst-class:: classref-method
  1430. :ref:`RID<class_RID>` **body_get_space**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_space>`
  1431. Returns the :ref:`RID<class_RID>` of the space assigned to a body.
  1432. .. rst-class:: classref-item-separator
  1433. ----
  1434. .. _class_PhysicsServer3D_method_body_get_state:
  1435. .. rst-class:: classref-method
  1436. :ref:`Variant<class_Variant>` **body_get_state**\ (\ body\: :ref:`RID<class_RID>`, state\: :ref:`BodyState<enum_PhysicsServer3D_BodyState>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_state>`
  1437. Returns a body state.
  1438. .. rst-class:: classref-item-separator
  1439. ----
  1440. .. _class_PhysicsServer3D_method_body_is_axis_locked:
  1441. .. rst-class:: classref-method
  1442. :ref:`bool<class_bool>` **body_is_axis_locked**\ (\ body\: :ref:`RID<class_RID>`, axis\: :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_is_axis_locked>`
  1443. .. container:: contribute
  1444. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1445. .. rst-class:: classref-item-separator
  1446. ----
  1447. .. _class_PhysicsServer3D_method_body_is_continuous_collision_detection_enabled:
  1448. .. rst-class:: classref-method
  1449. :ref:`bool<class_bool>` **body_is_continuous_collision_detection_enabled**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_is_continuous_collision_detection_enabled>`
  1450. If ``true``, the continuous collision detection mode is enabled.
  1451. .. rst-class:: classref-item-separator
  1452. ----
  1453. .. _class_PhysicsServer3D_method_body_is_omitting_force_integration:
  1454. .. rst-class:: classref-method
  1455. :ref:`bool<class_bool>` **body_is_omitting_force_integration**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_is_omitting_force_integration>`
  1456. Returns ``true`` if the body is omitting the standard force integration. See :ref:`body_set_omit_force_integration<class_PhysicsServer3D_method_body_set_omit_force_integration>`.
  1457. .. rst-class:: classref-item-separator
  1458. ----
  1459. .. _class_PhysicsServer3D_method_body_remove_collision_exception:
  1460. .. rst-class:: classref-method
  1461. |void| **body_remove_collision_exception**\ (\ body\: :ref:`RID<class_RID>`, excepted_body\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_remove_collision_exception>`
  1462. Removes a body from the list of bodies exempt from collisions.
  1463. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
  1464. .. rst-class:: classref-item-separator
  1465. ----
  1466. .. _class_PhysicsServer3D_method_body_remove_shape:
  1467. .. rst-class:: classref-method
  1468. |void| **body_remove_shape**\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_remove_shape>`
  1469. Removes a shape from a body. The shape is not deleted, so it can be reused afterwards.
  1470. .. rst-class:: classref-item-separator
  1471. ----
  1472. .. _class_PhysicsServer3D_method_body_reset_mass_properties:
  1473. .. rst-class:: classref-method
  1474. |void| **body_reset_mass_properties**\ (\ body\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_reset_mass_properties>`
  1475. Restores the default inertia and center of mass based on shapes to cancel any custom values previously set using :ref:`body_set_param<class_PhysicsServer3D_method_body_set_param>`.
  1476. .. rst-class:: classref-item-separator
  1477. ----
  1478. .. _class_PhysicsServer3D_method_body_set_axis_lock:
  1479. .. rst-class:: classref-method
  1480. |void| **body_set_axis_lock**\ (\ body\: :ref:`RID<class_RID>`, axis\: :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>`, lock\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_axis_lock>`
  1481. .. container:: contribute
  1482. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1483. .. rst-class:: classref-item-separator
  1484. ----
  1485. .. _class_PhysicsServer3D_method_body_set_axis_velocity:
  1486. .. rst-class:: classref-method
  1487. |void| **body_set_axis_velocity**\ (\ body\: :ref:`RID<class_RID>`, axis_velocity\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_axis_velocity>`
  1488. 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.
  1489. .. rst-class:: classref-item-separator
  1490. ----
  1491. .. _class_PhysicsServer3D_method_body_set_collision_layer:
  1492. .. rst-class:: classref-method
  1493. |void| **body_set_collision_layer**\ (\ body\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_collision_layer>`
  1494. Sets the physics layer or layers a body belongs to.
  1495. .. rst-class:: classref-item-separator
  1496. ----
  1497. .. _class_PhysicsServer3D_method_body_set_collision_mask:
  1498. .. rst-class:: classref-method
  1499. |void| **body_set_collision_mask**\ (\ body\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_collision_mask>`
  1500. Sets the physics layer or layers a body can collide with.
  1501. .. rst-class:: classref-item-separator
  1502. ----
  1503. .. _class_PhysicsServer3D_method_body_set_collision_priority:
  1504. .. rst-class:: classref-method
  1505. |void| **body_set_collision_priority**\ (\ body\: :ref:`RID<class_RID>`, priority\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_collision_priority>`
  1506. Sets the body's collision priority.
  1507. .. rst-class:: classref-item-separator
  1508. ----
  1509. .. _class_PhysicsServer3D_method_body_set_constant_force:
  1510. .. rst-class:: classref-method
  1511. |void| **body_set_constant_force**\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_constant_force>`
  1512. Sets the body's total constant positional forces applied during each physics update.
  1513. See :ref:`body_add_constant_force<class_PhysicsServer3D_method_body_add_constant_force>` and :ref:`body_add_constant_central_force<class_PhysicsServer3D_method_body_add_constant_central_force>`.
  1514. .. rst-class:: classref-item-separator
  1515. ----
  1516. .. _class_PhysicsServer3D_method_body_set_constant_torque:
  1517. .. rst-class:: classref-method
  1518. |void| **body_set_constant_torque**\ (\ body\: :ref:`RID<class_RID>`, torque\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_constant_torque>`
  1519. Sets the body's total constant rotational forces applied during each physics update.
  1520. See :ref:`body_add_constant_torque<class_PhysicsServer3D_method_body_add_constant_torque>`.
  1521. .. rst-class:: classref-item-separator
  1522. ----
  1523. .. _class_PhysicsServer3D_method_body_set_enable_continuous_collision_detection:
  1524. .. rst-class:: classref-method
  1525. |void| **body_set_enable_continuous_collision_detection**\ (\ body\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_enable_continuous_collision_detection>`
  1526. If ``true``, the continuous collision detection mode is enabled.
  1527. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
  1528. .. rst-class:: classref-item-separator
  1529. ----
  1530. .. _class_PhysicsServer3D_method_body_set_force_integration_callback:
  1531. .. rst-class:: classref-method
  1532. |void| **body_set_force_integration_callback**\ (\ body\: :ref:`RID<class_RID>`, callable\: :ref:`Callable<class_Callable>`, userdata\: :ref:`Variant<class_Variant>` = null\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_force_integration_callback>`
  1533. Sets the body's custom force integration callback function to ``callable``. Use an empty :ref:`Callable<class_Callable>` (``Callable()``) to clear the custom callback.
  1534. The function ``callable`` will be called every physics tick, before the standard force integration (see :ref:`body_set_omit_force_integration<class_PhysicsServer3D_method_body_set_omit_force_integration>`). It can be used for example to update the body's linear and angular velocity based on contact with other bodies.
  1535. If ``userdata`` is not ``null``, the function ``callable`` must take the following two parameters:
  1536. 1. ``state``: a :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>`, used to retrieve and modify the body's state,
  1537. 2. ``userdata``: a :ref:`Variant<class_Variant>`; its value will be the ``userdata`` passed into this method.
  1538. If ``userdata`` is ``null``, then ``callable`` must take only the ``state`` parameter.
  1539. .. rst-class:: classref-item-separator
  1540. ----
  1541. .. _class_PhysicsServer3D_method_body_set_max_contacts_reported:
  1542. .. rst-class:: classref-method
  1543. |void| **body_set_max_contacts_reported**\ (\ body\: :ref:`RID<class_RID>`, amount\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_max_contacts_reported>`
  1544. 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.
  1545. .. rst-class:: classref-item-separator
  1546. ----
  1547. .. _class_PhysicsServer3D_method_body_set_mode:
  1548. .. rst-class:: classref-method
  1549. |void| **body_set_mode**\ (\ body\: :ref:`RID<class_RID>`, mode\: :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_mode>`
  1550. Sets the body mode, from one of the :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` constants.
  1551. .. rst-class:: classref-item-separator
  1552. ----
  1553. .. _class_PhysicsServer3D_method_body_set_omit_force_integration:
  1554. .. rst-class:: classref-method
  1555. |void| **body_set_omit_force_integration**\ (\ body\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_omit_force_integration>`
  1556. Sets whether the body omits the standard force integration. If ``enable`` is ``true``, the body will not automatically use applied forces, torques, and damping to update the body's linear and angular velocity. In this case, :ref:`body_set_force_integration_callback<class_PhysicsServer3D_method_body_set_force_integration_callback>` can be used to manually update the linear and angular velocity instead.
  1557. This method is called when the property :ref:`RigidBody3D.custom_integrator<class_RigidBody3D_property_custom_integrator>` is set.
  1558. .. rst-class:: classref-item-separator
  1559. ----
  1560. .. _class_PhysicsServer3D_method_body_set_param:
  1561. .. rst-class:: classref-method
  1562. |void| **body_set_param**\ (\ body\: :ref:`RID<class_RID>`, param\: :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_param>`
  1563. Sets a body parameter. A list of available parameters is on the :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` constants.
  1564. .. rst-class:: classref-item-separator
  1565. ----
  1566. .. _class_PhysicsServer3D_method_body_set_ray_pickable:
  1567. .. rst-class:: classref-method
  1568. |void| **body_set_ray_pickable**\ (\ body\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_ray_pickable>`
  1569. Sets the body pickable with rays if ``enable`` is set.
  1570. .. rst-class:: classref-item-separator
  1571. ----
  1572. .. _class_PhysicsServer3D_method_body_set_shape:
  1573. .. rst-class:: classref-method
  1574. |void| **body_set_shape**\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, shape\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_shape>`
  1575. Substitutes a given body shape by another. The old shape is selected by its index, the new one by its :ref:`RID<class_RID>`.
  1576. .. rst-class:: classref-item-separator
  1577. ----
  1578. .. _class_PhysicsServer3D_method_body_set_shape_disabled:
  1579. .. rst-class:: classref-method
  1580. |void| **body_set_shape_disabled**\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_shape_disabled>`
  1581. .. container:: contribute
  1582. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1583. .. rst-class:: classref-item-separator
  1584. ----
  1585. .. _class_PhysicsServer3D_method_body_set_shape_transform:
  1586. .. rst-class:: classref-method
  1587. |void| **body_set_shape_transform**\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_shape_transform>`
  1588. Sets the transform matrix for a body shape.
  1589. .. rst-class:: classref-item-separator
  1590. ----
  1591. .. _class_PhysicsServer3D_method_body_set_space:
  1592. .. rst-class:: classref-method
  1593. |void| **body_set_space**\ (\ body\: :ref:`RID<class_RID>`, space\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_space>`
  1594. Assigns a space to the body (see :ref:`space_create<class_PhysicsServer3D_method_space_create>`).
  1595. .. rst-class:: classref-item-separator
  1596. ----
  1597. .. _class_PhysicsServer3D_method_body_set_state:
  1598. .. rst-class:: classref-method
  1599. |void| **body_set_state**\ (\ body\: :ref:`RID<class_RID>`, state\: :ref:`BodyState<enum_PhysicsServer3D_BodyState>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_state>`
  1600. Sets a body state (see :ref:`BodyState<enum_PhysicsServer3D_BodyState>` constants).
  1601. .. rst-class:: classref-item-separator
  1602. ----
  1603. .. _class_PhysicsServer3D_method_body_test_motion:
  1604. .. rst-class:: classref-method
  1605. :ref:`bool<class_bool>` **body_test_motion**\ (\ body\: :ref:`RID<class_RID>`, parameters\: :ref:`PhysicsTestMotionParameters3D<class_PhysicsTestMotionParameters3D>`, result\: :ref:`PhysicsTestMotionResult3D<class_PhysicsTestMotionResult3D>` = null\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_test_motion>`
  1606. Returns ``true`` if a collision would result from moving along a motion vector from a given point in space. :ref:`PhysicsTestMotionParameters3D<class_PhysicsTestMotionParameters3D>` is passed to set motion parameters. :ref:`PhysicsTestMotionResult3D<class_PhysicsTestMotionResult3D>` can be passed to return additional information.
  1607. .. rst-class:: classref-item-separator
  1608. ----
  1609. .. _class_PhysicsServer3D_method_box_shape_create:
  1610. .. rst-class:: classref-method
  1611. :ref:`RID<class_RID>` **box_shape_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_box_shape_create>`
  1612. .. container:: contribute
  1613. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1614. .. rst-class:: classref-item-separator
  1615. ----
  1616. .. _class_PhysicsServer3D_method_capsule_shape_create:
  1617. .. rst-class:: classref-method
  1618. :ref:`RID<class_RID>` **capsule_shape_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_capsule_shape_create>`
  1619. .. container:: contribute
  1620. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1621. .. rst-class:: classref-item-separator
  1622. ----
  1623. .. _class_PhysicsServer3D_method_concave_polygon_shape_create:
  1624. .. rst-class:: classref-method
  1625. :ref:`RID<class_RID>` **concave_polygon_shape_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_concave_polygon_shape_create>`
  1626. .. container:: contribute
  1627. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1628. .. rst-class:: classref-item-separator
  1629. ----
  1630. .. _class_PhysicsServer3D_method_cone_twist_joint_get_param:
  1631. .. rst-class:: classref-method
  1632. :ref:`float<class_float>` **cone_twist_joint_get_param**\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_cone_twist_joint_get_param>`
  1633. Gets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` constants).
  1634. .. rst-class:: classref-item-separator
  1635. ----
  1636. .. _class_PhysicsServer3D_method_cone_twist_joint_set_param:
  1637. .. rst-class:: classref-method
  1638. |void| **cone_twist_joint_set_param**\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>`, value\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_cone_twist_joint_set_param>`
  1639. Sets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` constants).
  1640. .. rst-class:: classref-item-separator
  1641. ----
  1642. .. _class_PhysicsServer3D_method_convex_polygon_shape_create:
  1643. .. rst-class:: classref-method
  1644. :ref:`RID<class_RID>` **convex_polygon_shape_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_convex_polygon_shape_create>`
  1645. .. container:: contribute
  1646. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1647. .. rst-class:: classref-item-separator
  1648. ----
  1649. .. _class_PhysicsServer3D_method_custom_shape_create:
  1650. .. rst-class:: classref-method
  1651. :ref:`RID<class_RID>` **custom_shape_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_custom_shape_create>`
  1652. .. container:: contribute
  1653. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1654. .. rst-class:: classref-item-separator
  1655. ----
  1656. .. _class_PhysicsServer3D_method_cylinder_shape_create:
  1657. .. rst-class:: classref-method
  1658. :ref:`RID<class_RID>` **cylinder_shape_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_cylinder_shape_create>`
  1659. .. container:: contribute
  1660. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1661. .. rst-class:: classref-item-separator
  1662. ----
  1663. .. _class_PhysicsServer3D_method_free_rid:
  1664. .. rst-class:: classref-method
  1665. |void| **free_rid**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_free_rid>`
  1666. Destroys any of the objects created by PhysicsServer3D. If the :ref:`RID<class_RID>` passed is not one of the objects that can be created by PhysicsServer3D, an error will be sent to the console.
  1667. .. rst-class:: classref-item-separator
  1668. ----
  1669. .. _class_PhysicsServer3D_method_generic_6dof_joint_get_flag:
  1670. .. rst-class:: classref-method
  1671. :ref:`bool<class_bool>` **generic_6dof_joint_get_flag**\ (\ joint\: :ref:`RID<class_RID>`, axis\: Vector3.Axis, flag\: :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_generic_6dof_joint_get_flag>`
  1672. Returns the value of a generic 6DOF joint flag. See :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` for the list of available flags.
  1673. .. rst-class:: classref-item-separator
  1674. ----
  1675. .. _class_PhysicsServer3D_method_generic_6dof_joint_get_param:
  1676. .. rst-class:: classref-method
  1677. :ref:`float<class_float>` **generic_6dof_joint_get_param**\ (\ joint\: :ref:`RID<class_RID>`, axis\: Vector3.Axis, param\: :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_generic_6dof_joint_get_param>`
  1678. Returns the value of a generic 6DOF joint parameter. See :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` for the list of available parameters.
  1679. .. rst-class:: classref-item-separator
  1680. ----
  1681. .. _class_PhysicsServer3D_method_generic_6dof_joint_set_flag:
  1682. .. rst-class:: classref-method
  1683. |void| **generic_6dof_joint_set_flag**\ (\ joint\: :ref:`RID<class_RID>`, axis\: Vector3.Axis, flag\: :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_generic_6dof_joint_set_flag>`
  1684. Sets the value of a given generic 6DOF joint flag. See :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` for the list of available flags.
  1685. .. rst-class:: classref-item-separator
  1686. ----
  1687. .. _class_PhysicsServer3D_method_generic_6dof_joint_set_param:
  1688. .. rst-class:: classref-method
  1689. |void| **generic_6dof_joint_set_param**\ (\ joint\: :ref:`RID<class_RID>`, axis\: Vector3.Axis, param\: :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>`, value\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_generic_6dof_joint_set_param>`
  1690. Sets the value of a given generic 6DOF joint parameter. See :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` for the list of available parameters.
  1691. .. rst-class:: classref-item-separator
  1692. ----
  1693. .. _class_PhysicsServer3D_method_get_process_info:
  1694. .. rst-class:: classref-method
  1695. :ref:`int<class_int>` **get_process_info**\ (\ process_info\: :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_get_process_info>`
  1696. Returns information about the current state of the 3D physics engine. See :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>` for a list of available states.
  1697. .. rst-class:: classref-item-separator
  1698. ----
  1699. .. _class_PhysicsServer3D_method_heightmap_shape_create:
  1700. .. rst-class:: classref-method
  1701. :ref:`RID<class_RID>` **heightmap_shape_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_heightmap_shape_create>`
  1702. .. container:: contribute
  1703. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1704. .. rst-class:: classref-item-separator
  1705. ----
  1706. .. _class_PhysicsServer3D_method_hinge_joint_get_flag:
  1707. .. rst-class:: classref-method
  1708. :ref:`bool<class_bool>` **hinge_joint_get_flag**\ (\ joint\: :ref:`RID<class_RID>`, flag\: :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_hinge_joint_get_flag>`
  1709. Gets a hinge_joint flag (see :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` constants).
  1710. .. rst-class:: classref-item-separator
  1711. ----
  1712. .. _class_PhysicsServer3D_method_hinge_joint_get_param:
  1713. .. rst-class:: classref-method
  1714. :ref:`float<class_float>` **hinge_joint_get_param**\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_hinge_joint_get_param>`
  1715. Gets a hinge_joint parameter (see :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>`).
  1716. .. rst-class:: classref-item-separator
  1717. ----
  1718. .. _class_PhysicsServer3D_method_hinge_joint_set_flag:
  1719. .. rst-class:: classref-method
  1720. |void| **hinge_joint_set_flag**\ (\ joint\: :ref:`RID<class_RID>`, flag\: :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_hinge_joint_set_flag>`
  1721. Sets a hinge_joint flag (see :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` constants).
  1722. .. rst-class:: classref-item-separator
  1723. ----
  1724. .. _class_PhysicsServer3D_method_hinge_joint_set_param:
  1725. .. rst-class:: classref-method
  1726. |void| **hinge_joint_set_param**\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>`, value\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_hinge_joint_set_param>`
  1727. Sets a hinge_joint parameter (see :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` constants).
  1728. .. rst-class:: classref-item-separator
  1729. ----
  1730. .. _class_PhysicsServer3D_method_joint_clear:
  1731. .. rst-class:: classref-method
  1732. |void| **joint_clear**\ (\ joint\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_joint_clear>`
  1733. .. container:: contribute
  1734. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1735. .. rst-class:: classref-item-separator
  1736. ----
  1737. .. _class_PhysicsServer3D_method_joint_create:
  1738. .. rst-class:: classref-method
  1739. :ref:`RID<class_RID>` **joint_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_joint_create>`
  1740. .. container:: contribute
  1741. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1742. .. rst-class:: classref-item-separator
  1743. ----
  1744. .. _class_PhysicsServer3D_method_joint_disable_collisions_between_bodies:
  1745. .. rst-class:: classref-method
  1746. |void| **joint_disable_collisions_between_bodies**\ (\ joint\: :ref:`RID<class_RID>`, disable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_joint_disable_collisions_between_bodies>`
  1747. Sets whether the bodies attached to the :ref:`Joint3D<class_Joint3D>` will collide with each other.
  1748. .. rst-class:: classref-item-separator
  1749. ----
  1750. .. _class_PhysicsServer3D_method_joint_get_solver_priority:
  1751. .. rst-class:: classref-method
  1752. :ref:`int<class_int>` **joint_get_solver_priority**\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_joint_get_solver_priority>`
  1753. Gets the priority value of the Joint3D.
  1754. .. rst-class:: classref-item-separator
  1755. ----
  1756. .. _class_PhysicsServer3D_method_joint_get_type:
  1757. .. rst-class:: classref-method
  1758. :ref:`JointType<enum_PhysicsServer3D_JointType>` **joint_get_type**\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_joint_get_type>`
  1759. Returns the type of the Joint3D.
  1760. .. rst-class:: classref-item-separator
  1761. ----
  1762. .. _class_PhysicsServer3D_method_joint_is_disabled_collisions_between_bodies:
  1763. .. rst-class:: classref-method
  1764. :ref:`bool<class_bool>` **joint_is_disabled_collisions_between_bodies**\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_joint_is_disabled_collisions_between_bodies>`
  1765. Returns whether the bodies attached to the :ref:`Joint3D<class_Joint3D>` will collide with each other.
  1766. .. rst-class:: classref-item-separator
  1767. ----
  1768. .. _class_PhysicsServer3D_method_joint_make_cone_twist:
  1769. .. rst-class:: classref-method
  1770. |void| **joint_make_cone_twist**\ (\ joint\: :ref:`RID<class_RID>`, body_A\: :ref:`RID<class_RID>`, local_ref_A\: :ref:`Transform3D<class_Transform3D>`, body_B\: :ref:`RID<class_RID>`, local_ref_B\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_joint_make_cone_twist>`
  1771. .. container:: contribute
  1772. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1773. .. rst-class:: classref-item-separator
  1774. ----
  1775. .. _class_PhysicsServer3D_method_joint_make_generic_6dof:
  1776. .. rst-class:: classref-method
  1777. |void| **joint_make_generic_6dof**\ (\ joint\: :ref:`RID<class_RID>`, body_A\: :ref:`RID<class_RID>`, local_ref_A\: :ref:`Transform3D<class_Transform3D>`, body_B\: :ref:`RID<class_RID>`, local_ref_B\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_joint_make_generic_6dof>`
  1778. Make the joint a generic six degrees of freedom (6DOF) joint. Use :ref:`generic_6dof_joint_set_flag<class_PhysicsServer3D_method_generic_6dof_joint_set_flag>` and :ref:`generic_6dof_joint_set_param<class_PhysicsServer3D_method_generic_6dof_joint_set_param>` to set the joint's flags and parameters respectively.
  1779. .. rst-class:: classref-item-separator
  1780. ----
  1781. .. _class_PhysicsServer3D_method_joint_make_hinge:
  1782. .. rst-class:: classref-method
  1783. |void| **joint_make_hinge**\ (\ joint\: :ref:`RID<class_RID>`, body_A\: :ref:`RID<class_RID>`, hinge_A\: :ref:`Transform3D<class_Transform3D>`, body_B\: :ref:`RID<class_RID>`, hinge_B\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_joint_make_hinge>`
  1784. .. container:: contribute
  1785. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1786. .. rst-class:: classref-item-separator
  1787. ----
  1788. .. _class_PhysicsServer3D_method_joint_make_pin:
  1789. .. rst-class:: classref-method
  1790. |void| **joint_make_pin**\ (\ joint\: :ref:`RID<class_RID>`, body_A\: :ref:`RID<class_RID>`, local_A\: :ref:`Vector3<class_Vector3>`, body_B\: :ref:`RID<class_RID>`, local_B\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_joint_make_pin>`
  1791. .. container:: contribute
  1792. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1793. .. rst-class:: classref-item-separator
  1794. ----
  1795. .. _class_PhysicsServer3D_method_joint_make_slider:
  1796. .. rst-class:: classref-method
  1797. |void| **joint_make_slider**\ (\ joint\: :ref:`RID<class_RID>`, body_A\: :ref:`RID<class_RID>`, local_ref_A\: :ref:`Transform3D<class_Transform3D>`, body_B\: :ref:`RID<class_RID>`, local_ref_B\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_joint_make_slider>`
  1798. .. container:: contribute
  1799. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1800. .. rst-class:: classref-item-separator
  1801. ----
  1802. .. _class_PhysicsServer3D_method_joint_set_solver_priority:
  1803. .. rst-class:: classref-method
  1804. |void| **joint_set_solver_priority**\ (\ joint\: :ref:`RID<class_RID>`, priority\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_joint_set_solver_priority>`
  1805. Sets the priority value of the Joint3D.
  1806. .. rst-class:: classref-item-separator
  1807. ----
  1808. .. _class_PhysicsServer3D_method_pin_joint_get_local_a:
  1809. .. rst-class:: classref-method
  1810. :ref:`Vector3<class_Vector3>` **pin_joint_get_local_a**\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_pin_joint_get_local_a>`
  1811. Returns position of the joint in the local space of body a of the joint.
  1812. .. rst-class:: classref-item-separator
  1813. ----
  1814. .. _class_PhysicsServer3D_method_pin_joint_get_local_b:
  1815. .. rst-class:: classref-method
  1816. :ref:`Vector3<class_Vector3>` **pin_joint_get_local_b**\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_pin_joint_get_local_b>`
  1817. Returns position of the joint in the local space of body b of the joint.
  1818. .. rst-class:: classref-item-separator
  1819. ----
  1820. .. _class_PhysicsServer3D_method_pin_joint_get_param:
  1821. .. rst-class:: classref-method
  1822. :ref:`float<class_float>` **pin_joint_get_param**\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_pin_joint_get_param>`
  1823. Gets a pin_joint parameter (see :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` constants).
  1824. .. rst-class:: classref-item-separator
  1825. ----
  1826. .. _class_PhysicsServer3D_method_pin_joint_set_local_a:
  1827. .. rst-class:: classref-method
  1828. |void| **pin_joint_set_local_a**\ (\ joint\: :ref:`RID<class_RID>`, local_A\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_pin_joint_set_local_a>`
  1829. Sets position of the joint in the local space of body a of the joint.
  1830. .. rst-class:: classref-item-separator
  1831. ----
  1832. .. _class_PhysicsServer3D_method_pin_joint_set_local_b:
  1833. .. rst-class:: classref-method
  1834. |void| **pin_joint_set_local_b**\ (\ joint\: :ref:`RID<class_RID>`, local_B\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_pin_joint_set_local_b>`
  1835. Sets position of the joint in the local space of body b of the joint.
  1836. .. rst-class:: classref-item-separator
  1837. ----
  1838. .. _class_PhysicsServer3D_method_pin_joint_set_param:
  1839. .. rst-class:: classref-method
  1840. |void| **pin_joint_set_param**\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>`, value\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_pin_joint_set_param>`
  1841. Sets a pin_joint parameter (see :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` constants).
  1842. .. rst-class:: classref-item-separator
  1843. ----
  1844. .. _class_PhysicsServer3D_method_separation_ray_shape_create:
  1845. .. rst-class:: classref-method
  1846. :ref:`RID<class_RID>` **separation_ray_shape_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_separation_ray_shape_create>`
  1847. .. container:: contribute
  1848. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1849. .. rst-class:: classref-item-separator
  1850. ----
  1851. .. _class_PhysicsServer3D_method_set_active:
  1852. .. rst-class:: classref-method
  1853. |void| **set_active**\ (\ active\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_set_active>`
  1854. Activates or deactivates the 3D physics engine.
  1855. .. rst-class:: classref-item-separator
  1856. ----
  1857. .. _class_PhysicsServer3D_method_shape_get_data:
  1858. .. rst-class:: classref-method
  1859. :ref:`Variant<class_Variant>` **shape_get_data**\ (\ shape\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_shape_get_data>`
  1860. Returns the shape data.
  1861. .. rst-class:: classref-item-separator
  1862. ----
  1863. .. _class_PhysicsServer3D_method_shape_get_margin:
  1864. .. rst-class:: classref-method
  1865. :ref:`float<class_float>` **shape_get_margin**\ (\ shape\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_shape_get_margin>`
  1866. Returns the collision margin for the shape.
  1867. \ **Note:** This is not used in Godot Physics, so will always return ``0``.
  1868. .. rst-class:: classref-item-separator
  1869. ----
  1870. .. _class_PhysicsServer3D_method_shape_get_type:
  1871. .. rst-class:: classref-method
  1872. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **shape_get_type**\ (\ shape\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_shape_get_type>`
  1873. Returns the type of shape (see :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` constants).
  1874. .. rst-class:: classref-item-separator
  1875. ----
  1876. .. _class_PhysicsServer3D_method_shape_set_data:
  1877. .. rst-class:: classref-method
  1878. |void| **shape_set_data**\ (\ shape\: :ref:`RID<class_RID>`, data\: :ref:`Variant<class_Variant>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_shape_set_data>`
  1879. 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_PhysicsServer3D_method_shape_get_type>`.
  1880. .. rst-class:: classref-item-separator
  1881. ----
  1882. .. _class_PhysicsServer3D_method_shape_set_margin:
  1883. .. rst-class:: classref-method
  1884. |void| **shape_set_margin**\ (\ shape\: :ref:`RID<class_RID>`, margin\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_shape_set_margin>`
  1885. Sets the collision margin for the shape.
  1886. \ **Note:** This is not used in Godot Physics.
  1887. .. rst-class:: classref-item-separator
  1888. ----
  1889. .. _class_PhysicsServer3D_method_slider_joint_get_param:
  1890. .. rst-class:: classref-method
  1891. :ref:`float<class_float>` **slider_joint_get_param**\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_slider_joint_get_param>`
  1892. Gets a slider_joint parameter (see :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` constants).
  1893. .. rst-class:: classref-item-separator
  1894. ----
  1895. .. _class_PhysicsServer3D_method_slider_joint_set_param:
  1896. .. rst-class:: classref-method
  1897. |void| **slider_joint_set_param**\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>`, value\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_slider_joint_set_param>`
  1898. Gets a slider_joint parameter (see :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` constants).
  1899. .. rst-class:: classref-item-separator
  1900. ----
  1901. .. _class_PhysicsServer3D_method_soft_body_add_collision_exception:
  1902. .. rst-class:: classref-method
  1903. |void| **soft_body_add_collision_exception**\ (\ body\: :ref:`RID<class_RID>`, body_b\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_add_collision_exception>`
  1904. Adds the given body to the list of bodies exempt from collisions.
  1905. .. rst-class:: classref-item-separator
  1906. ----
  1907. .. _class_PhysicsServer3D_method_soft_body_create:
  1908. .. rst-class:: classref-method
  1909. :ref:`RID<class_RID>` **soft_body_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_create>`
  1910. Creates a new soft body and returns its internal :ref:`RID<class_RID>`.
  1911. .. rst-class:: classref-item-separator
  1912. ----
  1913. .. _class_PhysicsServer3D_method_soft_body_get_bounds:
  1914. .. rst-class:: classref-method
  1915. :ref:`AABB<class_AABB>` **soft_body_get_bounds**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_bounds>`
  1916. Returns the bounds of the given soft body in global coordinates.
  1917. .. rst-class:: classref-item-separator
  1918. ----
  1919. .. _class_PhysicsServer3D_method_soft_body_get_collision_layer:
  1920. .. rst-class:: classref-method
  1921. :ref:`int<class_int>` **soft_body_get_collision_layer**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_collision_layer>`
  1922. Returns the physics layer or layers that the given soft body belongs to.
  1923. .. rst-class:: classref-item-separator
  1924. ----
  1925. .. _class_PhysicsServer3D_method_soft_body_get_collision_mask:
  1926. .. rst-class:: classref-method
  1927. :ref:`int<class_int>` **soft_body_get_collision_mask**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_collision_mask>`
  1928. Returns the physics layer or layers that the given soft body can collide with.
  1929. .. rst-class:: classref-item-separator
  1930. ----
  1931. .. _class_PhysicsServer3D_method_soft_body_get_damping_coefficient:
  1932. .. rst-class:: classref-method
  1933. :ref:`float<class_float>` **soft_body_get_damping_coefficient**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_damping_coefficient>`
  1934. Returns the damping coefficient of the given soft body.
  1935. .. rst-class:: classref-item-separator
  1936. ----
  1937. .. _class_PhysicsServer3D_method_soft_body_get_drag_coefficient:
  1938. .. rst-class:: classref-method
  1939. :ref:`float<class_float>` **soft_body_get_drag_coefficient**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_drag_coefficient>`
  1940. Returns the drag coefficient of the given soft body.
  1941. .. rst-class:: classref-item-separator
  1942. ----
  1943. .. _class_PhysicsServer3D_method_soft_body_get_linear_stiffness:
  1944. .. rst-class:: classref-method
  1945. :ref:`float<class_float>` **soft_body_get_linear_stiffness**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_linear_stiffness>`
  1946. Returns the linear stiffness of the given soft body.
  1947. .. rst-class:: classref-item-separator
  1948. ----
  1949. .. _class_PhysicsServer3D_method_soft_body_get_point_global_position:
  1950. .. rst-class:: classref-method
  1951. :ref:`Vector3<class_Vector3>` **soft_body_get_point_global_position**\ (\ body\: :ref:`RID<class_RID>`, point_index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_point_global_position>`
  1952. Returns the current position of the given soft body point in global coordinates.
  1953. .. rst-class:: classref-item-separator
  1954. ----
  1955. .. _class_PhysicsServer3D_method_soft_body_get_pressure_coefficient:
  1956. .. rst-class:: classref-method
  1957. :ref:`float<class_float>` **soft_body_get_pressure_coefficient**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_pressure_coefficient>`
  1958. Returns the pressure coefficient of the given soft body.
  1959. .. rst-class:: classref-item-separator
  1960. ----
  1961. .. _class_PhysicsServer3D_method_soft_body_get_simulation_precision:
  1962. .. rst-class:: classref-method
  1963. :ref:`int<class_int>` **soft_body_get_simulation_precision**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_simulation_precision>`
  1964. Returns the simulation precision of the given soft body.
  1965. .. rst-class:: classref-item-separator
  1966. ----
  1967. .. _class_PhysicsServer3D_method_soft_body_get_space:
  1968. .. rst-class:: classref-method
  1969. :ref:`RID<class_RID>` **soft_body_get_space**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_space>`
  1970. Returns the :ref:`RID<class_RID>` of the space assigned to the given soft body.
  1971. .. rst-class:: classref-item-separator
  1972. ----
  1973. .. _class_PhysicsServer3D_method_soft_body_get_state:
  1974. .. rst-class:: classref-method
  1975. :ref:`Variant<class_Variant>` **soft_body_get_state**\ (\ body\: :ref:`RID<class_RID>`, state\: :ref:`BodyState<enum_PhysicsServer3D_BodyState>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_state>`
  1976. Returns the given soft body state (see :ref:`BodyState<enum_PhysicsServer3D_BodyState>` constants).
  1977. \ **Note:** Godot's default physics implementation does not support :ref:`BODY_STATE_LINEAR_VELOCITY<class_PhysicsServer3D_constant_BODY_STATE_LINEAR_VELOCITY>`, :ref:`BODY_STATE_ANGULAR_VELOCITY<class_PhysicsServer3D_constant_BODY_STATE_ANGULAR_VELOCITY>`, :ref:`BODY_STATE_SLEEPING<class_PhysicsServer3D_constant_BODY_STATE_SLEEPING>`, or :ref:`BODY_STATE_CAN_SLEEP<class_PhysicsServer3D_constant_BODY_STATE_CAN_SLEEP>`.
  1978. .. rst-class:: classref-item-separator
  1979. ----
  1980. .. _class_PhysicsServer3D_method_soft_body_get_total_mass:
  1981. .. rst-class:: classref-method
  1982. :ref:`float<class_float>` **soft_body_get_total_mass**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_total_mass>`
  1983. Returns the total mass assigned to the given soft body.
  1984. .. rst-class:: classref-item-separator
  1985. ----
  1986. .. _class_PhysicsServer3D_method_soft_body_is_point_pinned:
  1987. .. rst-class:: classref-method
  1988. :ref:`bool<class_bool>` **soft_body_is_point_pinned**\ (\ body\: :ref:`RID<class_RID>`, point_index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_is_point_pinned>`
  1989. Returns whether the given soft body point is pinned.
  1990. .. rst-class:: classref-item-separator
  1991. ----
  1992. .. _class_PhysicsServer3D_method_soft_body_move_point:
  1993. .. rst-class:: classref-method
  1994. |void| **soft_body_move_point**\ (\ body\: :ref:`RID<class_RID>`, point_index\: :ref:`int<class_int>`, global_position\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_move_point>`
  1995. Moves the given soft body point to a position in global coordinates.
  1996. .. rst-class:: classref-item-separator
  1997. ----
  1998. .. _class_PhysicsServer3D_method_soft_body_pin_point:
  1999. .. rst-class:: classref-method
  2000. |void| **soft_body_pin_point**\ (\ body\: :ref:`RID<class_RID>`, point_index\: :ref:`int<class_int>`, pin\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_pin_point>`
  2001. Pins or unpins the given soft body point based on the value of ``pin``.
  2002. \ **Note:** Pinning a point effectively makes it kinematic, preventing it from being affected by forces, but you can still move it using :ref:`soft_body_move_point<class_PhysicsServer3D_method_soft_body_move_point>`.
  2003. .. rst-class:: classref-item-separator
  2004. ----
  2005. .. _class_PhysicsServer3D_method_soft_body_remove_all_pinned_points:
  2006. .. rst-class:: classref-method
  2007. |void| **soft_body_remove_all_pinned_points**\ (\ body\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_remove_all_pinned_points>`
  2008. Unpins all points of the given soft body.
  2009. .. rst-class:: classref-item-separator
  2010. ----
  2011. .. _class_PhysicsServer3D_method_soft_body_remove_collision_exception:
  2012. .. rst-class:: classref-method
  2013. |void| **soft_body_remove_collision_exception**\ (\ body\: :ref:`RID<class_RID>`, body_b\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_remove_collision_exception>`
  2014. Removes the given body from the list of bodies exempt from collisions.
  2015. .. rst-class:: classref-item-separator
  2016. ----
  2017. .. _class_PhysicsServer3D_method_soft_body_set_collision_layer:
  2018. .. rst-class:: classref-method
  2019. |void| **soft_body_set_collision_layer**\ (\ body\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_set_collision_layer>`
  2020. Sets the physics layer or layers the given soft body belongs to.
  2021. .. rst-class:: classref-item-separator
  2022. ----
  2023. .. _class_PhysicsServer3D_method_soft_body_set_collision_mask:
  2024. .. rst-class:: classref-method
  2025. |void| **soft_body_set_collision_mask**\ (\ body\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_set_collision_mask>`
  2026. Sets the physics layer or layers the given soft body can collide with.
  2027. .. rst-class:: classref-item-separator
  2028. ----
  2029. .. _class_PhysicsServer3D_method_soft_body_set_damping_coefficient:
  2030. .. rst-class:: classref-method
  2031. |void| **soft_body_set_damping_coefficient**\ (\ body\: :ref:`RID<class_RID>`, damping_coefficient\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_set_damping_coefficient>`
  2032. Sets the damping coefficient of the given soft body. Higher values will slow down the body more noticeably when forces are applied.
  2033. .. rst-class:: classref-item-separator
  2034. ----
  2035. .. _class_PhysicsServer3D_method_soft_body_set_drag_coefficient:
  2036. .. rst-class:: classref-method
  2037. |void| **soft_body_set_drag_coefficient**\ (\ body\: :ref:`RID<class_RID>`, drag_coefficient\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_set_drag_coefficient>`
  2038. Sets the drag coefficient of the given soft body. Higher values increase this body's air resistance.
  2039. \ **Note:** This value is currently unused by Godot's default physics implementation.
  2040. .. rst-class:: classref-item-separator
  2041. ----
  2042. .. _class_PhysicsServer3D_method_soft_body_set_linear_stiffness:
  2043. .. rst-class:: classref-method
  2044. |void| **soft_body_set_linear_stiffness**\ (\ body\: :ref:`RID<class_RID>`, stiffness\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_set_linear_stiffness>`
  2045. Sets the linear stiffness of the given soft body. Higher values will result in a stiffer body, while lower values will increase the body's ability to bend. The value can be between ``0.0`` and ``1.0`` (inclusive).
  2046. .. rst-class:: classref-item-separator
  2047. ----
  2048. .. _class_PhysicsServer3D_method_soft_body_set_mesh:
  2049. .. rst-class:: classref-method
  2050. |void| **soft_body_set_mesh**\ (\ body\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_set_mesh>`
  2051. Sets the mesh of the given soft body.
  2052. .. rst-class:: classref-item-separator
  2053. ----
  2054. .. _class_PhysicsServer3D_method_soft_body_set_pressure_coefficient:
  2055. .. rst-class:: classref-method
  2056. |void| **soft_body_set_pressure_coefficient**\ (\ body\: :ref:`RID<class_RID>`, pressure_coefficient\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_set_pressure_coefficient>`
  2057. Sets the pressure coefficient of the given soft body. Simulates pressure build-up from inside this body. Higher values increase the strength of this effect.
  2058. .. rst-class:: classref-item-separator
  2059. ----
  2060. .. _class_PhysicsServer3D_method_soft_body_set_ray_pickable:
  2061. .. rst-class:: classref-method
  2062. |void| **soft_body_set_ray_pickable**\ (\ body\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_set_ray_pickable>`
  2063. Sets whether the given soft body will be pickable when using object picking.
  2064. .. rst-class:: classref-item-separator
  2065. ----
  2066. .. _class_PhysicsServer3D_method_soft_body_set_simulation_precision:
  2067. .. rst-class:: classref-method
  2068. |void| **soft_body_set_simulation_precision**\ (\ body\: :ref:`RID<class_RID>`, simulation_precision\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_set_simulation_precision>`
  2069. Sets the simulation precision of the given soft body. Increasing this value will improve the resulting simulation, but can affect performance. Use with care.
  2070. .. rst-class:: classref-item-separator
  2071. ----
  2072. .. _class_PhysicsServer3D_method_soft_body_set_space:
  2073. .. rst-class:: classref-method
  2074. |void| **soft_body_set_space**\ (\ body\: :ref:`RID<class_RID>`, space\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_set_space>`
  2075. Assigns a space to the given soft body (see :ref:`space_create<class_PhysicsServer3D_method_space_create>`).
  2076. .. rst-class:: classref-item-separator
  2077. ----
  2078. .. _class_PhysicsServer3D_method_soft_body_set_state:
  2079. .. rst-class:: classref-method
  2080. |void| **soft_body_set_state**\ (\ body\: :ref:`RID<class_RID>`, state\: :ref:`BodyState<enum_PhysicsServer3D_BodyState>`, variant\: :ref:`Variant<class_Variant>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_set_state>`
  2081. Sets the given body state for the given body (see :ref:`BodyState<enum_PhysicsServer3D_BodyState>` constants).
  2082. \ **Note:** Godot's default physics implementation does not support :ref:`BODY_STATE_LINEAR_VELOCITY<class_PhysicsServer3D_constant_BODY_STATE_LINEAR_VELOCITY>`, :ref:`BODY_STATE_ANGULAR_VELOCITY<class_PhysicsServer3D_constant_BODY_STATE_ANGULAR_VELOCITY>`, :ref:`BODY_STATE_SLEEPING<class_PhysicsServer3D_constant_BODY_STATE_SLEEPING>`, or :ref:`BODY_STATE_CAN_SLEEP<class_PhysicsServer3D_constant_BODY_STATE_CAN_SLEEP>`.
  2083. .. rst-class:: classref-item-separator
  2084. ----
  2085. .. _class_PhysicsServer3D_method_soft_body_set_total_mass:
  2086. .. rst-class:: classref-method
  2087. |void| **soft_body_set_total_mass**\ (\ body\: :ref:`RID<class_RID>`, total_mass\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_set_total_mass>`
  2088. Sets the total mass for the given soft body.
  2089. .. rst-class:: classref-item-separator
  2090. ----
  2091. .. _class_PhysicsServer3D_method_soft_body_set_transform:
  2092. .. rst-class:: classref-method
  2093. |void| **soft_body_set_transform**\ (\ body\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_set_transform>`
  2094. Sets the global transform of the given soft body.
  2095. .. rst-class:: classref-item-separator
  2096. ----
  2097. .. _class_PhysicsServer3D_method_soft_body_update_rendering_server:
  2098. .. rst-class:: classref-method
  2099. |void| **soft_body_update_rendering_server**\ (\ body\: :ref:`RID<class_RID>`, rendering_server_handler\: :ref:`PhysicsServer3DRenderingServerHandler<class_PhysicsServer3DRenderingServerHandler>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_update_rendering_server>`
  2100. Requests that the physics server updates the rendering server with the latest positions of the given soft body's points through the ``rendering_server_handler`` interface.
  2101. .. rst-class:: classref-item-separator
  2102. ----
  2103. .. _class_PhysicsServer3D_method_space_create:
  2104. .. rst-class:: classref-method
  2105. :ref:`RID<class_RID>` **space_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_space_create>`
  2106. 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_PhysicsServer3D_method_area_set_space>`, or to a body with :ref:`body_set_space<class_PhysicsServer3D_method_body_set_space>`.
  2107. .. rst-class:: classref-item-separator
  2108. ----
  2109. .. _class_PhysicsServer3D_method_space_get_direct_state:
  2110. .. rst-class:: classref-method
  2111. :ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>` **space_get_direct_state**\ (\ space\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_space_get_direct_state>`
  2112. Returns the state of a space, a :ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>`. This object can be used to make collision/intersection queries.
  2113. .. rst-class:: classref-item-separator
  2114. ----
  2115. .. _class_PhysicsServer3D_method_space_get_param:
  2116. .. rst-class:: classref-method
  2117. :ref:`float<class_float>` **space_get_param**\ (\ space\: :ref:`RID<class_RID>`, param\: :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_space_get_param>`
  2118. Returns the value of a space parameter.
  2119. .. rst-class:: classref-item-separator
  2120. ----
  2121. .. _class_PhysicsServer3D_method_space_is_active:
  2122. .. rst-class:: classref-method
  2123. :ref:`bool<class_bool>` **space_is_active**\ (\ space\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_space_is_active>`
  2124. Returns whether the space is active.
  2125. .. rst-class:: classref-item-separator
  2126. ----
  2127. .. _class_PhysicsServer3D_method_space_set_active:
  2128. .. rst-class:: classref-method
  2129. |void| **space_set_active**\ (\ space\: :ref:`RID<class_RID>`, active\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_space_set_active>`
  2130. Marks a space as active. It will not have an effect, unless it is assigned to an area or body.
  2131. .. rst-class:: classref-item-separator
  2132. ----
  2133. .. _class_PhysicsServer3D_method_space_set_param:
  2134. .. rst-class:: classref-method
  2135. |void| **space_set_param**\ (\ space\: :ref:`RID<class_RID>`, param\: :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>`, value\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_space_set_param>`
  2136. Sets the value for a space parameter. A list of available parameters is on the :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` constants.
  2137. .. rst-class:: classref-item-separator
  2138. ----
  2139. .. _class_PhysicsServer3D_method_sphere_shape_create:
  2140. .. rst-class:: classref-method
  2141. :ref:`RID<class_RID>` **sphere_shape_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_sphere_shape_create>`
  2142. .. container:: contribute
  2143. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2144. .. rst-class:: classref-item-separator
  2145. ----
  2146. .. _class_PhysicsServer3D_method_world_boundary_shape_create:
  2147. .. rst-class:: classref-method
  2148. :ref:`RID<class_RID>` **world_boundary_shape_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_world_boundary_shape_create>`
  2149. .. container:: contribute
  2150. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2151. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  2152. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  2153. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  2154. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  2155. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  2156. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  2157. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  2158. .. |void| replace:: :abbr:`void (No return value.)`