class_physicsserver3d.rst 253 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014
  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. | |void| | :ref:`body_set_state_sync_callback<class_PhysicsServer3D_method_body_set_state_sync_callback>`\ (\ body\: :ref:`RID<class_RID>`, callable\: :ref:`Callable<class_Callable>`\ ) |
  190. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | :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\ ) |
  192. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | :ref:`RID<class_RID>` | :ref:`box_shape_create<class_PhysicsServer3D_method_box_shape_create>`\ (\ ) |
  194. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | :ref:`RID<class_RID>` | :ref:`capsule_shape_create<class_PhysicsServer3D_method_capsule_shape_create>`\ (\ ) |
  196. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | :ref:`RID<class_RID>` | :ref:`concave_polygon_shape_create<class_PhysicsServer3D_method_concave_polygon_shape_create>`\ (\ ) |
  198. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | :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| |
  200. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | |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>`\ ) |
  202. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | :ref:`RID<class_RID>` | :ref:`convex_polygon_shape_create<class_PhysicsServer3D_method_convex_polygon_shape_create>`\ (\ ) |
  204. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | :ref:`RID<class_RID>` | :ref:`custom_shape_create<class_PhysicsServer3D_method_custom_shape_create>`\ (\ ) |
  206. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | :ref:`RID<class_RID>` | :ref:`cylinder_shape_create<class_PhysicsServer3D_method_cylinder_shape_create>`\ (\ ) |
  208. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | |void| | :ref:`free_rid<class_PhysicsServer3D_method_free_rid>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  210. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | :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| |
  212. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. | :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| |
  214. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  215. | |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>`\ ) |
  216. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  217. | |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>`\ ) |
  218. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  219. | :ref:`int<class_int>` | :ref:`get_process_info<class_PhysicsServer3D_method_get_process_info>`\ (\ process_info\: :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>`\ ) |
  220. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  221. | :ref:`RID<class_RID>` | :ref:`heightmap_shape_create<class_PhysicsServer3D_method_heightmap_shape_create>`\ (\ ) |
  222. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  223. | :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| |
  224. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  225. | :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| |
  226. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  227. | |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>`\ ) |
  228. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  229. | |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>`\ ) |
  230. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  231. | |void| | :ref:`joint_clear<class_PhysicsServer3D_method_joint_clear>`\ (\ joint\: :ref:`RID<class_RID>`\ ) |
  232. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  233. | :ref:`RID<class_RID>` | :ref:`joint_create<class_PhysicsServer3D_method_joint_create>`\ (\ ) |
  234. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  235. | |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>`\ ) |
  236. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  237. | :ref:`int<class_int>` | :ref:`joint_get_solver_priority<class_PhysicsServer3D_method_joint_get_solver_priority>`\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| |
  238. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  239. | :ref:`JointType<enum_PhysicsServer3D_JointType>` | :ref:`joint_get_type<class_PhysicsServer3D_method_joint_get_type>`\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| |
  240. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  241. | :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| |
  242. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  243. | |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>`\ ) |
  244. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  245. | |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>`\ ) |
  246. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  247. | |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>`\ ) |
  248. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  249. | |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>`\ ) |
  250. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  251. | |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>`\ ) |
  252. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  253. | |void| | :ref:`joint_set_solver_priority<class_PhysicsServer3D_method_joint_set_solver_priority>`\ (\ joint\: :ref:`RID<class_RID>`, priority\: :ref:`int<class_int>`\ ) |
  254. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  255. | :ref:`Vector3<class_Vector3>` | :ref:`pin_joint_get_local_a<class_PhysicsServer3D_method_pin_joint_get_local_a>`\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| |
  256. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  257. | :ref:`Vector3<class_Vector3>` | :ref:`pin_joint_get_local_b<class_PhysicsServer3D_method_pin_joint_get_local_b>`\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| |
  258. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  259. | :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| |
  260. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  261. | |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>`\ ) |
  262. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  263. | |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>`\ ) |
  264. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  265. | |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>`\ ) |
  266. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  267. | :ref:`RID<class_RID>` | :ref:`separation_ray_shape_create<class_PhysicsServer3D_method_separation_ray_shape_create>`\ (\ ) |
  268. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  269. | |void| | :ref:`set_active<class_PhysicsServer3D_method_set_active>`\ (\ active\: :ref:`bool<class_bool>`\ ) |
  270. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  271. | :ref:`Variant<class_Variant>` | :ref:`shape_get_data<class_PhysicsServer3D_method_shape_get_data>`\ (\ shape\: :ref:`RID<class_RID>`\ ) |const| |
  272. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  273. | :ref:`float<class_float>` | :ref:`shape_get_margin<class_PhysicsServer3D_method_shape_get_margin>`\ (\ shape\: :ref:`RID<class_RID>`\ ) |const| |
  274. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  275. | :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` | :ref:`shape_get_type<class_PhysicsServer3D_method_shape_get_type>`\ (\ shape\: :ref:`RID<class_RID>`\ ) |const| |
  276. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  277. | |void| | :ref:`shape_set_data<class_PhysicsServer3D_method_shape_set_data>`\ (\ shape\: :ref:`RID<class_RID>`, data\: :ref:`Variant<class_Variant>`\ ) |
  278. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  279. | |void| | :ref:`shape_set_margin<class_PhysicsServer3D_method_shape_set_margin>`\ (\ shape\: :ref:`RID<class_RID>`, margin\: :ref:`float<class_float>`\ ) |
  280. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  281. | :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| |
  282. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  283. | |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>`\ ) |
  284. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  285. | |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>`\ ) |
  286. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  287. | :ref:`RID<class_RID>` | :ref:`soft_body_create<class_PhysicsServer3D_method_soft_body_create>`\ (\ ) |
  288. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  289. | :ref:`AABB<class_AABB>` | :ref:`soft_body_get_bounds<class_PhysicsServer3D_method_soft_body_get_bounds>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  290. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  291. | :ref:`int<class_int>` | :ref:`soft_body_get_collision_layer<class_PhysicsServer3D_method_soft_body_get_collision_layer>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  292. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  293. | :ref:`int<class_int>` | :ref:`soft_body_get_collision_mask<class_PhysicsServer3D_method_soft_body_get_collision_mask>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  294. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  295. | :ref:`float<class_float>` | :ref:`soft_body_get_damping_coefficient<class_PhysicsServer3D_method_soft_body_get_damping_coefficient>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  296. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  297. | :ref:`float<class_float>` | :ref:`soft_body_get_drag_coefficient<class_PhysicsServer3D_method_soft_body_get_drag_coefficient>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  298. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  299. | :ref:`float<class_float>` | :ref:`soft_body_get_linear_stiffness<class_PhysicsServer3D_method_soft_body_get_linear_stiffness>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  300. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  301. | :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| |
  302. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  303. | :ref:`float<class_float>` | :ref:`soft_body_get_pressure_coefficient<class_PhysicsServer3D_method_soft_body_get_pressure_coefficient>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  304. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  305. | :ref:`int<class_int>` | :ref:`soft_body_get_simulation_precision<class_PhysicsServer3D_method_soft_body_get_simulation_precision>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  306. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  307. | :ref:`RID<class_RID>` | :ref:`soft_body_get_space<class_PhysicsServer3D_method_soft_body_get_space>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  308. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  309. | :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| |
  310. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  311. | :ref:`float<class_float>` | :ref:`soft_body_get_total_mass<class_PhysicsServer3D_method_soft_body_get_total_mass>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  312. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  313. | :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| |
  314. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  315. | |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>`\ ) |
  316. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  317. | |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>`\ ) |
  318. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  319. | |void| | :ref:`soft_body_remove_all_pinned_points<class_PhysicsServer3D_method_soft_body_remove_all_pinned_points>`\ (\ body\: :ref:`RID<class_RID>`\ ) |
  320. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  321. | |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>`\ ) |
  322. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  323. | |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>`\ ) |
  324. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  325. | |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>`\ ) |
  326. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  327. | |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>`\ ) |
  328. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  329. | |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>`\ ) |
  330. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  331. | |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>`\ ) |
  332. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  333. | |void| | :ref:`soft_body_set_mesh<class_PhysicsServer3D_method_soft_body_set_mesh>`\ (\ body\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`\ ) |
  334. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  335. | |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>`\ ) |
  336. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  337. | |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>`\ ) |
  338. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  339. | |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>`\ ) |
  340. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  341. | |void| | :ref:`soft_body_set_space<class_PhysicsServer3D_method_soft_body_set_space>`\ (\ body\: :ref:`RID<class_RID>`, space\: :ref:`RID<class_RID>`\ ) |
  342. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  343. | |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>`\ ) |
  344. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  345. | |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>`\ ) |
  346. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  347. | |void| | :ref:`soft_body_set_transform<class_PhysicsServer3D_method_soft_body_set_transform>`\ (\ body\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  348. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  349. | |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>`\ ) |
  350. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  351. | :ref:`RID<class_RID>` | :ref:`space_create<class_PhysicsServer3D_method_space_create>`\ (\ ) |
  352. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  353. | :ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>` | :ref:`space_get_direct_state<class_PhysicsServer3D_method_space_get_direct_state>`\ (\ space\: :ref:`RID<class_RID>`\ ) |
  354. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  355. | :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| |
  356. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  357. | :ref:`bool<class_bool>` | :ref:`space_is_active<class_PhysicsServer3D_method_space_is_active>`\ (\ space\: :ref:`RID<class_RID>`\ ) |const| |
  358. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  359. | |void| | :ref:`space_set_active<class_PhysicsServer3D_method_space_set_active>`\ (\ space\: :ref:`RID<class_RID>`, active\: :ref:`bool<class_bool>`\ ) |
  360. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  361. | |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>`\ ) |
  362. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  363. | :ref:`RID<class_RID>` | :ref:`sphere_shape_create<class_PhysicsServer3D_method_sphere_shape_create>`\ (\ ) |
  364. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  365. | :ref:`RID<class_RID>` | :ref:`world_boundary_shape_create<class_PhysicsServer3D_method_world_boundary_shape_create>`\ (\ ) |
  366. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  367. .. rst-class:: classref-section-separator
  368. ----
  369. .. rst-class:: classref-descriptions-group
  370. Enumerations
  371. ------------
  372. .. _enum_PhysicsServer3D_JointType:
  373. .. rst-class:: classref-enumeration
  374. enum **JointType**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_JointType>`
  375. .. _class_PhysicsServer3D_constant_JOINT_TYPE_PIN:
  376. .. rst-class:: classref-enumeration-constant
  377. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_PIN** = ``0``
  378. The :ref:`Joint3D<class_Joint3D>` is a :ref:`PinJoint3D<class_PinJoint3D>`.
  379. .. _class_PhysicsServer3D_constant_JOINT_TYPE_HINGE:
  380. .. rst-class:: classref-enumeration-constant
  381. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_HINGE** = ``1``
  382. The :ref:`Joint3D<class_Joint3D>` is a :ref:`HingeJoint3D<class_HingeJoint3D>`.
  383. .. _class_PhysicsServer3D_constant_JOINT_TYPE_SLIDER:
  384. .. rst-class:: classref-enumeration-constant
  385. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_SLIDER** = ``2``
  386. The :ref:`Joint3D<class_Joint3D>` is a :ref:`SliderJoint3D<class_SliderJoint3D>`.
  387. .. _class_PhysicsServer3D_constant_JOINT_TYPE_CONE_TWIST:
  388. .. rst-class:: classref-enumeration-constant
  389. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_CONE_TWIST** = ``3``
  390. The :ref:`Joint3D<class_Joint3D>` is a :ref:`ConeTwistJoint3D<class_ConeTwistJoint3D>`.
  391. .. _class_PhysicsServer3D_constant_JOINT_TYPE_6DOF:
  392. .. rst-class:: classref-enumeration-constant
  393. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_6DOF** = ``4``
  394. The :ref:`Joint3D<class_Joint3D>` is a :ref:`Generic6DOFJoint3D<class_Generic6DOFJoint3D>`.
  395. .. _class_PhysicsServer3D_constant_JOINT_TYPE_MAX:
  396. .. rst-class:: classref-enumeration-constant
  397. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_MAX** = ``5``
  398. Represents the size of the :ref:`JointType<enum_PhysicsServer3D_JointType>` enum.
  399. .. rst-class:: classref-item-separator
  400. ----
  401. .. _enum_PhysicsServer3D_PinJointParam:
  402. .. rst-class:: classref-enumeration
  403. enum **PinJointParam**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_PinJointParam>`
  404. .. _class_PhysicsServer3D_constant_PIN_JOINT_BIAS:
  405. .. rst-class:: classref-enumeration-constant
  406. :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` **PIN_JOINT_BIAS** = ``0``
  407. The strength with which the pinned objects try to stay in positional relation to each other.
  408. The higher, the stronger.
  409. .. _class_PhysicsServer3D_constant_PIN_JOINT_DAMPING:
  410. .. rst-class:: classref-enumeration-constant
  411. :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` **PIN_JOINT_DAMPING** = ``1``
  412. The strength with which the pinned objects try to stay in velocity relation to each other.
  413. The higher, the stronger.
  414. .. _class_PhysicsServer3D_constant_PIN_JOINT_IMPULSE_CLAMP:
  415. .. rst-class:: classref-enumeration-constant
  416. :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` **PIN_JOINT_IMPULSE_CLAMP** = ``2``
  417. If above 0, this value is the maximum value for an impulse that this Joint3D puts on its ends.
  418. .. rst-class:: classref-item-separator
  419. ----
  420. .. _enum_PhysicsServer3D_HingeJointParam:
  421. .. rst-class:: classref-enumeration
  422. enum **HingeJointParam**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_HingeJointParam>`
  423. .. _class_PhysicsServer3D_constant_HINGE_JOINT_BIAS:
  424. .. rst-class:: classref-enumeration-constant
  425. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_BIAS** = ``0``
  426. The speed with which the two bodies get pulled together when they move in different directions.
  427. .. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_UPPER:
  428. .. rst-class:: classref-enumeration-constant
  429. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_LIMIT_UPPER** = ``1``
  430. The maximum rotation across the Hinge.
  431. .. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_LOWER:
  432. .. rst-class:: classref-enumeration-constant
  433. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_LIMIT_LOWER** = ``2``
  434. The minimum rotation across the Hinge.
  435. .. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_BIAS:
  436. .. rst-class:: classref-enumeration-constant
  437. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_LIMIT_BIAS** = ``3``
  438. The speed with which the rotation across the axis perpendicular to the hinge gets corrected.
  439. .. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_SOFTNESS:
  440. .. rst-class:: classref-enumeration-constant
  441. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_LIMIT_SOFTNESS** = ``4``
  442. .. container:: contribute
  443. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  444. .. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_RELAXATION:
  445. .. rst-class:: classref-enumeration-constant
  446. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_LIMIT_RELAXATION** = ``5``
  447. The lower this value, the more the rotation gets slowed down.
  448. .. _class_PhysicsServer3D_constant_HINGE_JOINT_MOTOR_TARGET_VELOCITY:
  449. .. rst-class:: classref-enumeration-constant
  450. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_MOTOR_TARGET_VELOCITY** = ``6``
  451. Target speed for the motor.
  452. .. _class_PhysicsServer3D_constant_HINGE_JOINT_MOTOR_MAX_IMPULSE:
  453. .. rst-class:: classref-enumeration-constant
  454. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_MOTOR_MAX_IMPULSE** = ``7``
  455. Maximum acceleration for the motor.
  456. .. rst-class:: classref-item-separator
  457. ----
  458. .. _enum_PhysicsServer3D_HingeJointFlag:
  459. .. rst-class:: classref-enumeration
  460. enum **HingeJointFlag**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_HingeJointFlag>`
  461. .. _class_PhysicsServer3D_constant_HINGE_JOINT_FLAG_USE_LIMIT:
  462. .. rst-class:: classref-enumeration-constant
  463. :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` **HINGE_JOINT_FLAG_USE_LIMIT** = ``0``
  464. If ``true``, the Hinge has a maximum and a minimum rotation.
  465. .. _class_PhysicsServer3D_constant_HINGE_JOINT_FLAG_ENABLE_MOTOR:
  466. .. rst-class:: classref-enumeration-constant
  467. :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` **HINGE_JOINT_FLAG_ENABLE_MOTOR** = ``1``
  468. If ``true``, a motor turns the Hinge.
  469. .. rst-class:: classref-item-separator
  470. ----
  471. .. _enum_PhysicsServer3D_SliderJointParam:
  472. .. rst-class:: classref-enumeration
  473. enum **SliderJointParam**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_SliderJointParam>`
  474. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_UPPER:
  475. .. rst-class:: classref-enumeration-constant
  476. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_LIMIT_UPPER** = ``0``
  477. The maximum difference between the pivot points on their X axis before damping happens.
  478. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_LOWER:
  479. .. rst-class:: classref-enumeration-constant
  480. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_LIMIT_LOWER** = ``1``
  481. The minimum difference between the pivot points on their X axis before damping happens.
  482. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS:
  483. .. rst-class:: classref-enumeration-constant
  484. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS** = ``2``
  485. A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.
  486. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION:
  487. .. rst-class:: classref-enumeration-constant
  488. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION** = ``3``
  489. The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost.
  490. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_DAMPING:
  491. .. rst-class:: classref-enumeration-constant
  492. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_LIMIT_DAMPING** = ``4``
  493. The amount of damping once the slider limits are surpassed.
  494. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_MOTION_SOFTNESS:
  495. .. rst-class:: classref-enumeration-constant
  496. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_MOTION_SOFTNESS** = ``5``
  497. 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.
  498. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_MOTION_RESTITUTION:
  499. .. rst-class:: classref-enumeration-constant
  500. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_MOTION_RESTITUTION** = ``6``
  501. The amount of restitution inside the slider limits.
  502. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_MOTION_DAMPING:
  503. .. rst-class:: classref-enumeration-constant
  504. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_MOTION_DAMPING** = ``7``
  505. The amount of damping inside the slider limits.
  506. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS:
  507. .. rst-class:: classref-enumeration-constant
  508. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS** = ``8``
  509. A factor applied to the movement across axes orthogonal to the slider.
  510. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION:
  511. .. rst-class:: classref-enumeration-constant
  512. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION** = ``9``
  513. The amount of restitution when movement is across axes orthogonal to the slider.
  514. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING:
  515. .. rst-class:: classref-enumeration-constant
  516. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING** = ``10``
  517. The amount of damping when movement is across axes orthogonal to the slider.
  518. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_UPPER:
  519. .. rst-class:: classref-enumeration-constant
  520. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_LIMIT_UPPER** = ``11``
  521. The upper limit of rotation in the slider.
  522. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_LOWER:
  523. .. rst-class:: classref-enumeration-constant
  524. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_LIMIT_LOWER** = ``12``
  525. The lower limit of rotation in the slider.
  526. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS:
  527. .. rst-class:: classref-enumeration-constant
  528. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS** = ``13``
  529. A factor applied to the all rotation once the limit is surpassed.
  530. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION:
  531. .. rst-class:: classref-enumeration-constant
  532. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION** = ``14``
  533. The amount of restitution of the rotation when the limit is surpassed.
  534. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_DAMPING:
  535. .. rst-class:: classref-enumeration-constant
  536. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_LIMIT_DAMPING** = ``15``
  537. The amount of damping of the rotation when the limit is surpassed.
  538. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS:
  539. .. rst-class:: classref-enumeration-constant
  540. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS** = ``16``
  541. A factor that gets applied to the all rotation in the limits.
  542. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION:
  543. .. rst-class:: classref-enumeration-constant
  544. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION** = ``17``
  545. The amount of restitution of the rotation in the limits.
  546. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_MOTION_DAMPING:
  547. .. rst-class:: classref-enumeration-constant
  548. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_MOTION_DAMPING** = ``18``
  549. The amount of damping of the rotation in the limits.
  550. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS:
  551. .. rst-class:: classref-enumeration-constant
  552. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS** = ``19``
  553. A factor that gets applied to the all rotation across axes orthogonal to the slider.
  554. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION:
  555. .. rst-class:: classref-enumeration-constant
  556. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION** = ``20``
  557. The amount of restitution of the rotation across axes orthogonal to the slider.
  558. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING:
  559. .. rst-class:: classref-enumeration-constant
  560. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING** = ``21``
  561. The amount of damping of the rotation across axes orthogonal to the slider.
  562. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_MAX:
  563. .. rst-class:: classref-enumeration-constant
  564. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_MAX** = ``22``
  565. Represents the size of the :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` enum.
  566. .. rst-class:: classref-item-separator
  567. ----
  568. .. _enum_PhysicsServer3D_ConeTwistJointParam:
  569. .. rst-class:: classref-enumeration
  570. enum **ConeTwistJointParam**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_ConeTwistJointParam>`
  571. .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_SWING_SPAN:
  572. .. rst-class:: classref-enumeration-constant
  573. :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` **CONE_TWIST_JOINT_SWING_SPAN** = ``0``
  574. Swing is rotation from side to side, around the axis perpendicular to the twist axis.
  575. The swing span defines, how much rotation will not get corrected along the swing axis.
  576. Could be defined as looseness in the :ref:`ConeTwistJoint3D<class_ConeTwistJoint3D>`.
  577. If below 0.05, this behavior is locked.
  578. .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_TWIST_SPAN:
  579. .. rst-class:: classref-enumeration-constant
  580. :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` **CONE_TWIST_JOINT_TWIST_SPAN** = ``1``
  581. Twist is the rotation around the twist axis, this value defined how far the joint can twist.
  582. Twist is locked if below 0.05.
  583. .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_BIAS:
  584. .. rst-class:: classref-enumeration-constant
  585. :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` **CONE_TWIST_JOINT_BIAS** = ``2``
  586. The speed with which the swing or twist will take place.
  587. The higher, the faster.
  588. .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_SOFTNESS:
  589. .. rst-class:: classref-enumeration-constant
  590. :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` **CONE_TWIST_JOINT_SOFTNESS** = ``3``
  591. The ease with which the Joint3D twists, if it's too low, it takes more force to twist the joint.
  592. .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_RELAXATION:
  593. .. rst-class:: classref-enumeration-constant
  594. :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` **CONE_TWIST_JOINT_RELAXATION** = ``4``
  595. Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
  596. .. rst-class:: classref-item-separator
  597. ----
  598. .. _enum_PhysicsServer3D_G6DOFJointAxisParam:
  599. .. rst-class:: classref-enumeration
  600. enum **G6DOFJointAxisParam**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_G6DOFJointAxisParam>`
  601. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_LOWER_LIMIT:
  602. .. rst-class:: classref-enumeration-constant
  603. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_LOWER_LIMIT** = ``0``
  604. The minimum difference between the pivot points' axes.
  605. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_UPPER_LIMIT:
  606. .. rst-class:: classref-enumeration-constant
  607. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_UPPER_LIMIT** = ``1``
  608. The maximum difference between the pivot points' axes.
  609. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS:
  610. .. rst-class:: classref-enumeration-constant
  611. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS** = ``2``
  612. A factor that gets applied to the movement across the axes. The lower, the slower the movement.
  613. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_RESTITUTION:
  614. .. rst-class:: classref-enumeration-constant
  615. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_RESTITUTION** = ``3``
  616. The amount of restitution on the axes movement. The lower, the more velocity-energy gets lost.
  617. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_DAMPING:
  618. .. rst-class:: classref-enumeration-constant
  619. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_DAMPING** = ``4``
  620. The amount of damping that happens at the linear motion across the axes.
  621. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_MOTOR_TARGET_VELOCITY:
  622. .. rst-class:: classref-enumeration-constant
  623. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_MOTOR_TARGET_VELOCITY** = ``5``
  624. The velocity that the joint's linear motor will attempt to reach.
  625. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_MOTOR_FORCE_LIMIT:
  626. .. rst-class:: classref-enumeration-constant
  627. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_MOTOR_FORCE_LIMIT** = ``6``
  628. The maximum force that the linear motor can apply while trying to reach the target velocity.
  629. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_SPRING_STIFFNESS:
  630. .. rst-class:: classref-enumeration-constant
  631. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_SPRING_STIFFNESS** = ``7``
  632. .. container:: contribute
  633. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  634. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_SPRING_DAMPING:
  635. .. rst-class:: classref-enumeration-constant
  636. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_SPRING_DAMPING** = ``8``
  637. .. container:: contribute
  638. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  639. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_SPRING_EQUILIBRIUM_POINT:
  640. .. rst-class:: classref-enumeration-constant
  641. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_SPRING_EQUILIBRIUM_POINT** = ``9``
  642. .. container:: contribute
  643. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  644. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_LOWER_LIMIT:
  645. .. rst-class:: classref-enumeration-constant
  646. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_LOWER_LIMIT** = ``10``
  647. The minimum rotation in negative direction to break loose and rotate around the axes.
  648. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_UPPER_LIMIT:
  649. .. rst-class:: classref-enumeration-constant
  650. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_UPPER_LIMIT** = ``11``
  651. The minimum rotation in positive direction to break loose and rotate around the axes.
  652. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS:
  653. .. rst-class:: classref-enumeration-constant
  654. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS** = ``12``
  655. A factor that gets multiplied onto all rotations across the axes.
  656. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_DAMPING:
  657. .. rst-class:: classref-enumeration-constant
  658. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_DAMPING** = ``13``
  659. The amount of rotational damping across the axes. The lower, the more damping occurs.
  660. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_RESTITUTION:
  661. .. rst-class:: classref-enumeration-constant
  662. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_RESTITUTION** = ``14``
  663. The amount of rotational restitution across the axes. The lower, the more restitution occurs.
  664. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_FORCE_LIMIT:
  665. .. rst-class:: classref-enumeration-constant
  666. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_FORCE_LIMIT** = ``15``
  667. The maximum amount of force that can occur, when rotating around the axes.
  668. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_ERP:
  669. .. rst-class:: classref-enumeration-constant
  670. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_ERP** = ``16``
  671. 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.
  672. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY:
  673. .. rst-class:: classref-enumeration-constant
  674. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY** = ``17``
  675. Target speed for the motor at the axes.
  676. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT:
  677. .. rst-class:: classref-enumeration-constant
  678. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT** = ``18``
  679. Maximum acceleration for the motor at the axes.
  680. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_SPRING_STIFFNESS:
  681. .. rst-class:: classref-enumeration-constant
  682. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_SPRING_STIFFNESS** = ``19``
  683. .. container:: contribute
  684. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  685. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_SPRING_DAMPING:
  686. .. rst-class:: classref-enumeration-constant
  687. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_SPRING_DAMPING** = ``20``
  688. .. container:: contribute
  689. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  690. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_SPRING_EQUILIBRIUM_POINT:
  691. .. rst-class:: classref-enumeration-constant
  692. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_SPRING_EQUILIBRIUM_POINT** = ``21``
  693. .. container:: contribute
  694. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  695. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_MAX:
  696. .. rst-class:: classref-enumeration-constant
  697. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_MAX** = ``22``
  698. Represents the size of the :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` enum.
  699. .. rst-class:: classref-item-separator
  700. ----
  701. .. _enum_PhysicsServer3D_G6DOFJointAxisFlag:
  702. .. rst-class:: classref-enumeration
  703. enum **G6DOFJointAxisFlag**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_G6DOFJointAxisFlag>`
  704. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT:
  705. .. rst-class:: classref-enumeration-constant
  706. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT** = ``0``
  707. If set, linear motion is possible within the given limits.
  708. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT:
  709. .. rst-class:: classref-enumeration-constant
  710. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT** = ``1``
  711. If set, rotational motion is possible.
  712. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_ANGULAR_SPRING:
  713. .. rst-class:: classref-enumeration-constant
  714. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_ANGULAR_SPRING** = ``2``
  715. .. container:: contribute
  716. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  717. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_LINEAR_SPRING:
  718. .. rst-class:: classref-enumeration-constant
  719. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_LINEAR_SPRING** = ``3``
  720. .. container:: contribute
  721. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  722. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_MOTOR:
  723. .. rst-class:: classref-enumeration-constant
  724. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_MOTOR** = ``4``
  725. If set, there is a rotational motor across these axes.
  726. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR:
  727. .. rst-class:: classref-enumeration-constant
  728. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR** = ``5``
  729. If set, there is a linear motor on this axis that targets a specific velocity.
  730. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_MAX:
  731. .. rst-class:: classref-enumeration-constant
  732. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_MAX** = ``6``
  733. Represents the size of the :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` enum.
  734. .. rst-class:: classref-item-separator
  735. ----
  736. .. _enum_PhysicsServer3D_ShapeType:
  737. .. rst-class:: classref-enumeration
  738. enum **ShapeType**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_ShapeType>`
  739. .. _class_PhysicsServer3D_constant_SHAPE_WORLD_BOUNDARY:
  740. .. rst-class:: classref-enumeration-constant
  741. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_WORLD_BOUNDARY** = ``0``
  742. The :ref:`Shape3D<class_Shape3D>` is a :ref:`WorldBoundaryShape3D<class_WorldBoundaryShape3D>`.
  743. .. _class_PhysicsServer3D_constant_SHAPE_SEPARATION_RAY:
  744. .. rst-class:: classref-enumeration-constant
  745. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_SEPARATION_RAY** = ``1``
  746. The :ref:`Shape3D<class_Shape3D>` is a :ref:`SeparationRayShape3D<class_SeparationRayShape3D>`.
  747. .. _class_PhysicsServer3D_constant_SHAPE_SPHERE:
  748. .. rst-class:: classref-enumeration-constant
  749. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_SPHERE** = ``2``
  750. The :ref:`Shape3D<class_Shape3D>` is a :ref:`SphereShape3D<class_SphereShape3D>`.
  751. .. _class_PhysicsServer3D_constant_SHAPE_BOX:
  752. .. rst-class:: classref-enumeration-constant
  753. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_BOX** = ``3``
  754. The :ref:`Shape3D<class_Shape3D>` is a :ref:`BoxShape3D<class_BoxShape3D>`.
  755. .. _class_PhysicsServer3D_constant_SHAPE_CAPSULE:
  756. .. rst-class:: classref-enumeration-constant
  757. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_CAPSULE** = ``4``
  758. The :ref:`Shape3D<class_Shape3D>` is a :ref:`CapsuleShape3D<class_CapsuleShape3D>`.
  759. .. _class_PhysicsServer3D_constant_SHAPE_CYLINDER:
  760. .. rst-class:: classref-enumeration-constant
  761. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_CYLINDER** = ``5``
  762. The :ref:`Shape3D<class_Shape3D>` is a :ref:`CylinderShape3D<class_CylinderShape3D>`.
  763. .. _class_PhysicsServer3D_constant_SHAPE_CONVEX_POLYGON:
  764. .. rst-class:: classref-enumeration-constant
  765. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_CONVEX_POLYGON** = ``6``
  766. The :ref:`Shape3D<class_Shape3D>` is a :ref:`ConvexPolygonShape3D<class_ConvexPolygonShape3D>`.
  767. .. _class_PhysicsServer3D_constant_SHAPE_CONCAVE_POLYGON:
  768. .. rst-class:: classref-enumeration-constant
  769. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_CONCAVE_POLYGON** = ``7``
  770. The :ref:`Shape3D<class_Shape3D>` is a :ref:`ConcavePolygonShape3D<class_ConcavePolygonShape3D>`.
  771. .. _class_PhysicsServer3D_constant_SHAPE_HEIGHTMAP:
  772. .. rst-class:: classref-enumeration-constant
  773. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_HEIGHTMAP** = ``8``
  774. The :ref:`Shape3D<class_Shape3D>` is a :ref:`HeightMapShape3D<class_HeightMapShape3D>`.
  775. .. _class_PhysicsServer3D_constant_SHAPE_SOFT_BODY:
  776. .. rst-class:: classref-enumeration-constant
  777. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_SOFT_BODY** = ``9``
  778. The :ref:`Shape3D<class_Shape3D>` is used internally for a soft body. Any attempt to create this kind of shape results in an error.
  779. .. _class_PhysicsServer3D_constant_SHAPE_CUSTOM:
  780. .. rst-class:: classref-enumeration-constant
  781. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_CUSTOM** = ``10``
  782. This constant is used internally by the engine. Any attempt to create this kind of shape results in an error.
  783. .. rst-class:: classref-item-separator
  784. ----
  785. .. _enum_PhysicsServer3D_AreaParameter:
  786. .. rst-class:: classref-enumeration
  787. enum **AreaParameter**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_AreaParameter>`
  788. .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_OVERRIDE_MODE:
  789. .. rst-class:: classref-enumeration-constant
  790. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY_OVERRIDE_MODE** = ``0``
  791. Constant to set/get gravity override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` for possible values.
  792. .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY:
  793. .. rst-class:: classref-enumeration-constant
  794. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY** = ``1``
  795. Constant to set/get gravity strength in an area.
  796. .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_VECTOR:
  797. .. rst-class:: classref-enumeration-constant
  798. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY_VECTOR** = ``2``
  799. Constant to set/get gravity vector/center in an area.
  800. .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_IS_POINT:
  801. .. rst-class:: classref-enumeration-constant
  802. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY_IS_POINT** = ``3``
  803. Constant to set/get whether the gravity vector of an area is a direction, or a center point.
  804. .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_POINT_UNIT_DISTANCE:
  805. .. rst-class:: classref-enumeration-constant
  806. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY_POINT_UNIT_DISTANCE** = ``4``
  807. 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.
  808. 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.
  809. .. _class_PhysicsServer3D_constant_AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE:
  810. .. rst-class:: classref-enumeration-constant
  811. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE** = ``5``
  812. Constant to set/get linear damping override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` for possible values.
  813. .. _class_PhysicsServer3D_constant_AREA_PARAM_LINEAR_DAMP:
  814. .. rst-class:: classref-enumeration-constant
  815. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_LINEAR_DAMP** = ``6``
  816. Constant to set/get the linear damping factor of an area.
  817. .. _class_PhysicsServer3D_constant_AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE:
  818. .. rst-class:: classref-enumeration-constant
  819. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE** = ``7``
  820. Constant to set/get angular damping override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` for possible values.
  821. .. _class_PhysicsServer3D_constant_AREA_PARAM_ANGULAR_DAMP:
  822. .. rst-class:: classref-enumeration-constant
  823. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_ANGULAR_DAMP** = ``8``
  824. Constant to set/get the angular damping factor of an area.
  825. .. _class_PhysicsServer3D_constant_AREA_PARAM_PRIORITY:
  826. .. rst-class:: classref-enumeration-constant
  827. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_PRIORITY** = ``9``
  828. Constant to set/get the priority (order of processing) of an area.
  829. .. _class_PhysicsServer3D_constant_AREA_PARAM_WIND_FORCE_MAGNITUDE:
  830. .. rst-class:: classref-enumeration-constant
  831. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_FORCE_MAGNITUDE** = ``10``
  832. 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.
  833. .. _class_PhysicsServer3D_constant_AREA_PARAM_WIND_SOURCE:
  834. .. rst-class:: classref-enumeration-constant
  835. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_SOURCE** = ``11``
  836. Constant to set/get the 3D vector that specifies the origin from which an area-specific wind blows.
  837. .. _class_PhysicsServer3D_constant_AREA_PARAM_WIND_DIRECTION:
  838. .. rst-class:: classref-enumeration-constant
  839. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_DIRECTION** = ``12``
  840. Constant to set/get the 3D vector that specifies the direction in which an area-specific wind blows.
  841. .. _class_PhysicsServer3D_constant_AREA_PARAM_WIND_ATTENUATION_FACTOR:
  842. .. rst-class:: classref-enumeration-constant
  843. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_ATTENUATION_FACTOR** = ``13``
  844. Constant to set/get the exponential rate at which wind force decreases with distance from its origin.
  845. .. rst-class:: classref-item-separator
  846. ----
  847. .. _enum_PhysicsServer3D_AreaSpaceOverrideMode:
  848. .. rst-class:: classref-enumeration
  849. enum **AreaSpaceOverrideMode**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_AreaSpaceOverrideMode>`
  850. .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_DISABLED:
  851. .. rst-class:: classref-enumeration-constant
  852. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_DISABLED** = ``0``
  853. This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
  854. .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_COMBINE:
  855. .. rst-class:: classref-enumeration-constant
  856. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_COMBINE** = ``1``
  857. 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.
  858. .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_COMBINE_REPLACE:
  859. .. rst-class:: classref-enumeration-constant
  860. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_COMBINE_REPLACE** = ``2``
  861. 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.
  862. .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_REPLACE:
  863. .. rst-class:: classref-enumeration-constant
  864. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_REPLACE** = ``3``
  865. This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
  866. .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_REPLACE_COMBINE:
  867. .. rst-class:: classref-enumeration-constant
  868. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_REPLACE_COMBINE** = ``4``
  869. This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
  870. .. rst-class:: classref-item-separator
  871. ----
  872. .. _enum_PhysicsServer3D_BodyMode:
  873. .. rst-class:: classref-enumeration
  874. enum **BodyMode**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_BodyMode>`
  875. .. _class_PhysicsServer3D_constant_BODY_MODE_STATIC:
  876. .. rst-class:: classref-enumeration-constant
  877. :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **BODY_MODE_STATIC** = ``0``
  878. 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.
  879. .. _class_PhysicsServer3D_constant_BODY_MODE_KINEMATIC:
  880. .. rst-class:: classref-enumeration-constant
  881. :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **BODY_MODE_KINEMATIC** = ``1``
  882. Constant for kinematic bodies. In this mode, a body can be only moved by user code and collides with other bodies along its path.
  883. .. _class_PhysicsServer3D_constant_BODY_MODE_RIGID:
  884. .. rst-class:: classref-enumeration-constant
  885. :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **BODY_MODE_RIGID** = ``2``
  886. Constant for rigid bodies. In this mode, a body can be pushed by other bodies and has forces applied.
  887. .. _class_PhysicsServer3D_constant_BODY_MODE_RIGID_LINEAR:
  888. .. rst-class:: classref-enumeration-constant
  889. :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **BODY_MODE_RIGID_LINEAR** = ``3``
  890. Constant for linear rigid bodies. In this mode, a body can not rotate, and only its linear velocity is affected by external forces.
  891. .. rst-class:: classref-item-separator
  892. ----
  893. .. _enum_PhysicsServer3D_BodyParameter:
  894. .. rst-class:: classref-enumeration
  895. enum **BodyParameter**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_BodyParameter>`
  896. .. _class_PhysicsServer3D_constant_BODY_PARAM_BOUNCE:
  897. .. rst-class:: classref-enumeration-constant
  898. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_BOUNCE** = ``0``
  899. Constant to set/get a body's bounce factor.
  900. .. _class_PhysicsServer3D_constant_BODY_PARAM_FRICTION:
  901. .. rst-class:: classref-enumeration-constant
  902. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_FRICTION** = ``1``
  903. Constant to set/get a body's friction.
  904. .. _class_PhysicsServer3D_constant_BODY_PARAM_MASS:
  905. .. rst-class:: classref-enumeration-constant
  906. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_MASS** = ``2``
  907. Constant to set/get a body's mass.
  908. .. _class_PhysicsServer3D_constant_BODY_PARAM_INERTIA:
  909. .. rst-class:: classref-enumeration-constant
  910. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_INERTIA** = ``3``
  911. Constant to set/get a body's inertia.
  912. .. _class_PhysicsServer3D_constant_BODY_PARAM_CENTER_OF_MASS:
  913. .. rst-class:: classref-enumeration-constant
  914. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_CENTER_OF_MASS** = ``4``
  915. Constant to set/get a body's center of mass position in the body's local coordinate system.
  916. .. _class_PhysicsServer3D_constant_BODY_PARAM_GRAVITY_SCALE:
  917. .. rst-class:: classref-enumeration-constant
  918. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_GRAVITY_SCALE** = ``5``
  919. Constant to set/get a body's gravity multiplier.
  920. .. _class_PhysicsServer3D_constant_BODY_PARAM_LINEAR_DAMP_MODE:
  921. .. rst-class:: classref-enumeration-constant
  922. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_LINEAR_DAMP_MODE** = ``6``
  923. Constant to set/get a body's linear damping mode. See :ref:`BodyDampMode<enum_PhysicsServer3D_BodyDampMode>` for possible values.
  924. .. _class_PhysicsServer3D_constant_BODY_PARAM_ANGULAR_DAMP_MODE:
  925. .. rst-class:: classref-enumeration-constant
  926. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_ANGULAR_DAMP_MODE** = ``7``
  927. Constant to set/get a body's angular damping mode. See :ref:`BodyDampMode<enum_PhysicsServer3D_BodyDampMode>` for possible values.
  928. .. _class_PhysicsServer3D_constant_BODY_PARAM_LINEAR_DAMP:
  929. .. rst-class:: classref-enumeration-constant
  930. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_LINEAR_DAMP** = ``8``
  931. Constant to set/get a body's linear damping factor.
  932. .. _class_PhysicsServer3D_constant_BODY_PARAM_ANGULAR_DAMP:
  933. .. rst-class:: classref-enumeration-constant
  934. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_ANGULAR_DAMP** = ``9``
  935. Constant to set/get a body's angular damping factor.
  936. .. _class_PhysicsServer3D_constant_BODY_PARAM_MAX:
  937. .. rst-class:: classref-enumeration-constant
  938. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_MAX** = ``10``
  939. Represents the size of the :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` enum.
  940. .. rst-class:: classref-item-separator
  941. ----
  942. .. _enum_PhysicsServer3D_BodyDampMode:
  943. .. rst-class:: classref-enumeration
  944. enum **BodyDampMode**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_BodyDampMode>`
  945. .. _class_PhysicsServer3D_constant_BODY_DAMP_MODE_COMBINE:
  946. .. rst-class:: classref-enumeration-constant
  947. :ref:`BodyDampMode<enum_PhysicsServer3D_BodyDampMode>` **BODY_DAMP_MODE_COMBINE** = ``0``
  948. The body's damping value is added to any value set in areas or the default value.
  949. .. _class_PhysicsServer3D_constant_BODY_DAMP_MODE_REPLACE:
  950. .. rst-class:: classref-enumeration-constant
  951. :ref:`BodyDampMode<enum_PhysicsServer3D_BodyDampMode>` **BODY_DAMP_MODE_REPLACE** = ``1``
  952. The body's damping value replaces any value set in areas or the default value.
  953. .. rst-class:: classref-item-separator
  954. ----
  955. .. _enum_PhysicsServer3D_BodyState:
  956. .. rst-class:: classref-enumeration
  957. enum **BodyState**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_BodyState>`
  958. .. _class_PhysicsServer3D_constant_BODY_STATE_TRANSFORM:
  959. .. rst-class:: classref-enumeration-constant
  960. :ref:`BodyState<enum_PhysicsServer3D_BodyState>` **BODY_STATE_TRANSFORM** = ``0``
  961. Constant to set/get the current transform matrix of the body.
  962. .. _class_PhysicsServer3D_constant_BODY_STATE_LINEAR_VELOCITY:
  963. .. rst-class:: classref-enumeration-constant
  964. :ref:`BodyState<enum_PhysicsServer3D_BodyState>` **BODY_STATE_LINEAR_VELOCITY** = ``1``
  965. Constant to set/get the current linear velocity of the body.
  966. .. _class_PhysicsServer3D_constant_BODY_STATE_ANGULAR_VELOCITY:
  967. .. rst-class:: classref-enumeration-constant
  968. :ref:`BodyState<enum_PhysicsServer3D_BodyState>` **BODY_STATE_ANGULAR_VELOCITY** = ``2``
  969. Constant to set/get the current angular velocity of the body.
  970. .. _class_PhysicsServer3D_constant_BODY_STATE_SLEEPING:
  971. .. rst-class:: classref-enumeration-constant
  972. :ref:`BodyState<enum_PhysicsServer3D_BodyState>` **BODY_STATE_SLEEPING** = ``3``
  973. Constant to sleep/wake up a body, or to get whether it is sleeping.
  974. .. _class_PhysicsServer3D_constant_BODY_STATE_CAN_SLEEP:
  975. .. rst-class:: classref-enumeration-constant
  976. :ref:`BodyState<enum_PhysicsServer3D_BodyState>` **BODY_STATE_CAN_SLEEP** = ``4``
  977. Constant to set/get whether the body can sleep.
  978. .. rst-class:: classref-item-separator
  979. ----
  980. .. _enum_PhysicsServer3D_AreaBodyStatus:
  981. .. rst-class:: classref-enumeration
  982. enum **AreaBodyStatus**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_AreaBodyStatus>`
  983. .. _class_PhysicsServer3D_constant_AREA_BODY_ADDED:
  984. .. rst-class:: classref-enumeration-constant
  985. :ref:`AreaBodyStatus<enum_PhysicsServer3D_AreaBodyStatus>` **AREA_BODY_ADDED** = ``0``
  986. The value of the first parameter and area callback function receives, when an object enters one of its shapes.
  987. .. _class_PhysicsServer3D_constant_AREA_BODY_REMOVED:
  988. .. rst-class:: classref-enumeration-constant
  989. :ref:`AreaBodyStatus<enum_PhysicsServer3D_AreaBodyStatus>` **AREA_BODY_REMOVED** = ``1``
  990. The value of the first parameter and area callback function receives, when an object exits one of its shapes.
  991. .. rst-class:: classref-item-separator
  992. ----
  993. .. _enum_PhysicsServer3D_ProcessInfo:
  994. .. rst-class:: classref-enumeration
  995. enum **ProcessInfo**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_ProcessInfo>`
  996. .. _class_PhysicsServer3D_constant_INFO_ACTIVE_OBJECTS:
  997. .. rst-class:: classref-enumeration-constant
  998. :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>` **INFO_ACTIVE_OBJECTS** = ``0``
  999. Constant to get the number of objects that are not sleeping.
  1000. .. _class_PhysicsServer3D_constant_INFO_COLLISION_PAIRS:
  1001. .. rst-class:: classref-enumeration-constant
  1002. :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>` **INFO_COLLISION_PAIRS** = ``1``
  1003. Constant to get the number of possible collisions.
  1004. .. _class_PhysicsServer3D_constant_INFO_ISLAND_COUNT:
  1005. .. rst-class:: classref-enumeration-constant
  1006. :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>` **INFO_ISLAND_COUNT** = ``2``
  1007. Constant to get the number of space regions where a collision could occur.
  1008. .. rst-class:: classref-item-separator
  1009. ----
  1010. .. _enum_PhysicsServer3D_SpaceParameter:
  1011. .. rst-class:: classref-enumeration
  1012. enum **SpaceParameter**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_SpaceParameter>`
  1013. .. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_RECYCLE_RADIUS:
  1014. .. rst-class:: classref-enumeration-constant
  1015. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_CONTACT_RECYCLE_RADIUS** = ``0``
  1016. Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated.
  1017. .. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_MAX_SEPARATION:
  1018. .. rst-class:: classref-enumeration-constant
  1019. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_CONTACT_MAX_SEPARATION** = ``1``
  1020. Constant to set/get the maximum distance a shape can be from another before they are considered separated and the contact is discarded.
  1021. .. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION:
  1022. .. rst-class:: classref-enumeration-constant
  1023. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION** = ``2``
  1024. Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision.
  1025. .. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_DEFAULT_BIAS:
  1026. .. rst-class:: classref-enumeration-constant
  1027. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_CONTACT_DEFAULT_BIAS** = ``3``
  1028. 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.
  1029. .. _class_PhysicsServer3D_constant_SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD:
  1030. .. rst-class:: classref-enumeration-constant
  1031. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD** = ``4``
  1032. 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.
  1033. .. _class_PhysicsServer3D_constant_SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD:
  1034. .. rst-class:: classref-enumeration-constant
  1035. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD** = ``5``
  1036. 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.
  1037. .. _class_PhysicsServer3D_constant_SPACE_PARAM_BODY_TIME_TO_SLEEP:
  1038. .. rst-class:: classref-enumeration-constant
  1039. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_BODY_TIME_TO_SLEEP** = ``6``
  1040. 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.
  1041. .. _class_PhysicsServer3D_constant_SPACE_PARAM_SOLVER_ITERATIONS:
  1042. .. rst-class:: classref-enumeration-constant
  1043. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_SOLVER_ITERATIONS** = ``7``
  1044. 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.
  1045. .. rst-class:: classref-item-separator
  1046. ----
  1047. .. _enum_PhysicsServer3D_BodyAxis:
  1048. .. rst-class:: classref-enumeration
  1049. enum **BodyAxis**: :ref:`๐Ÿ”—<enum_PhysicsServer3D_BodyAxis>`
  1050. .. _class_PhysicsServer3D_constant_BODY_AXIS_LINEAR_X:
  1051. .. rst-class:: classref-enumeration-constant
  1052. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_LINEAR_X** = ``1``
  1053. .. container:: contribute
  1054. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1055. .. _class_PhysicsServer3D_constant_BODY_AXIS_LINEAR_Y:
  1056. .. rst-class:: classref-enumeration-constant
  1057. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_LINEAR_Y** = ``2``
  1058. .. container:: contribute
  1059. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1060. .. _class_PhysicsServer3D_constant_BODY_AXIS_LINEAR_Z:
  1061. .. rst-class:: classref-enumeration-constant
  1062. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_LINEAR_Z** = ``4``
  1063. .. container:: contribute
  1064. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1065. .. _class_PhysicsServer3D_constant_BODY_AXIS_ANGULAR_X:
  1066. .. rst-class:: classref-enumeration-constant
  1067. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_ANGULAR_X** = ``8``
  1068. .. container:: contribute
  1069. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1070. .. _class_PhysicsServer3D_constant_BODY_AXIS_ANGULAR_Y:
  1071. .. rst-class:: classref-enumeration-constant
  1072. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_ANGULAR_Y** = ``16``
  1073. .. container:: contribute
  1074. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1075. .. _class_PhysicsServer3D_constant_BODY_AXIS_ANGULAR_Z:
  1076. .. rst-class:: classref-enumeration-constant
  1077. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_ANGULAR_Z** = ``32``
  1078. .. container:: contribute
  1079. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1080. .. rst-class:: classref-section-separator
  1081. ----
  1082. .. rst-class:: classref-descriptions-group
  1083. Method Descriptions
  1084. -------------------
  1085. .. _class_PhysicsServer3D_method_area_add_shape:
  1086. .. rst-class:: classref-method
  1087. |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>`
  1088. 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.
  1089. .. rst-class:: classref-item-separator
  1090. ----
  1091. .. _class_PhysicsServer3D_method_area_attach_object_instance_id:
  1092. .. rst-class:: classref-method
  1093. |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>`
  1094. Assigns the area to a descendant of :ref:`Object<class_Object>`, so it can exist in the node tree.
  1095. .. rst-class:: classref-item-separator
  1096. ----
  1097. .. _class_PhysicsServer3D_method_area_clear_shapes:
  1098. .. rst-class:: classref-method
  1099. |void| **area_clear_shapes**\ (\ area\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_clear_shapes>`
  1100. Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later.
  1101. .. rst-class:: classref-item-separator
  1102. ----
  1103. .. _class_PhysicsServer3D_method_area_create:
  1104. .. rst-class:: classref-method
  1105. :ref:`RID<class_RID>` **area_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_create>`
  1106. 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``.
  1107. 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>`.
  1108. .. rst-class:: classref-item-separator
  1109. ----
  1110. .. _class_PhysicsServer3D_method_area_get_collision_layer:
  1111. .. rst-class:: classref-method
  1112. :ref:`int<class_int>` **area_get_collision_layer**\ (\ area\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_get_collision_layer>`
  1113. Returns the physics layer or layers an area belongs to.
  1114. .. rst-class:: classref-item-separator
  1115. ----
  1116. .. _class_PhysicsServer3D_method_area_get_collision_mask:
  1117. .. rst-class:: classref-method
  1118. :ref:`int<class_int>` **area_get_collision_mask**\ (\ area\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_get_collision_mask>`
  1119. Returns the physics layer or layers an area can contact with.
  1120. .. rst-class:: classref-item-separator
  1121. ----
  1122. .. _class_PhysicsServer3D_method_area_get_object_instance_id:
  1123. .. rst-class:: classref-method
  1124. :ref:`int<class_int>` **area_get_object_instance_id**\ (\ area\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_get_object_instance_id>`
  1125. Gets the instance ID of the object the area is assigned to.
  1126. .. rst-class:: classref-item-separator
  1127. ----
  1128. .. _class_PhysicsServer3D_method_area_get_param:
  1129. .. rst-class:: classref-method
  1130. :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>`
  1131. Returns an area parameter value. A list of available parameters is on the :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` constants.
  1132. .. rst-class:: classref-item-separator
  1133. ----
  1134. .. _class_PhysicsServer3D_method_area_get_shape:
  1135. .. rst-class:: classref-method
  1136. :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>`
  1137. Returns the :ref:`RID<class_RID>` of the nth shape of an area.
  1138. .. rst-class:: classref-item-separator
  1139. ----
  1140. .. _class_PhysicsServer3D_method_area_get_shape_count:
  1141. .. rst-class:: classref-method
  1142. :ref:`int<class_int>` **area_get_shape_count**\ (\ area\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_get_shape_count>`
  1143. Returns the number of shapes assigned to an area.
  1144. .. rst-class:: classref-item-separator
  1145. ----
  1146. .. _class_PhysicsServer3D_method_area_get_shape_transform:
  1147. .. rst-class:: classref-method
  1148. :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>`
  1149. Returns the transform matrix of a shape within an area.
  1150. .. rst-class:: classref-item-separator
  1151. ----
  1152. .. _class_PhysicsServer3D_method_area_get_space:
  1153. .. rst-class:: classref-method
  1154. :ref:`RID<class_RID>` **area_get_space**\ (\ area\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_get_space>`
  1155. Returns the space assigned to the area.
  1156. .. rst-class:: classref-item-separator
  1157. ----
  1158. .. _class_PhysicsServer3D_method_area_get_transform:
  1159. .. rst-class:: classref-method
  1160. :ref:`Transform3D<class_Transform3D>` **area_get_transform**\ (\ area\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_get_transform>`
  1161. Returns the transform matrix for an area.
  1162. .. rst-class:: classref-item-separator
  1163. ----
  1164. .. _class_PhysicsServer3D_method_area_remove_shape:
  1165. .. rst-class:: classref-method
  1166. |void| **area_remove_shape**\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_remove_shape>`
  1167. Removes a shape from an area. It does not delete the shape, so it can be reassigned later.
  1168. .. rst-class:: classref-item-separator
  1169. ----
  1170. .. _class_PhysicsServer3D_method_area_set_area_monitor_callback:
  1171. .. rst-class:: classref-method
  1172. |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>`
  1173. 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:
  1174. 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,
  1175. 2. an :ref:`RID<class_RID>` ``area_rid``: the :ref:`RID<class_RID>` of the other area that entered or exited the area,
  1176. 3. an integer ``instance_id``: the ``ObjectID`` attached to the other area,
  1177. 4. an integer ``area_shape_idx``: the index of the shape of the other area that entered or exited the area,
  1178. 5. an integer ``self_shape_idx``: the index of the shape of the area where the other area entered or exited.
  1179. 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.
  1180. .. rst-class:: classref-item-separator
  1181. ----
  1182. .. _class_PhysicsServer3D_method_area_set_collision_layer:
  1183. .. rst-class:: classref-method
  1184. |void| **area_set_collision_layer**\ (\ area\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_set_collision_layer>`
  1185. Assigns the area to one or many physics layers.
  1186. .. rst-class:: classref-item-separator
  1187. ----
  1188. .. _class_PhysicsServer3D_method_area_set_collision_mask:
  1189. .. rst-class:: classref-method
  1190. |void| **area_set_collision_mask**\ (\ area\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_set_collision_mask>`
  1191. Sets which physics layers the area will monitor.
  1192. .. rst-class:: classref-item-separator
  1193. ----
  1194. .. _class_PhysicsServer3D_method_area_set_monitor_callback:
  1195. .. rst-class:: classref-method
  1196. |void| **area_set_monitor_callback**\ (\ area\: :ref:`RID<class_RID>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_set_monitor_callback>`
  1197. 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:
  1198. 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,
  1199. 2. an :ref:`RID<class_RID>` ``body_rid``: the :ref:`RID<class_RID>` of the body that entered or exited the area,
  1200. 3. an integer ``instance_id``: the ``ObjectID`` attached to the body,
  1201. 4. an integer ``body_shape_idx``: the index of the shape of the body that entered or exited the area,
  1202. 5. an integer ``self_shape_idx``: the index of the shape of the area where the body entered or exited.
  1203. 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.
  1204. .. rst-class:: classref-item-separator
  1205. ----
  1206. .. _class_PhysicsServer3D_method_area_set_monitorable:
  1207. .. rst-class:: classref-method
  1208. |void| **area_set_monitorable**\ (\ area\: :ref:`RID<class_RID>`, monitorable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_set_monitorable>`
  1209. .. container:: contribute
  1210. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1211. .. rst-class:: classref-item-separator
  1212. ----
  1213. .. _class_PhysicsServer3D_method_area_set_param:
  1214. .. rst-class:: classref-method
  1215. |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>`
  1216. Sets the value for an area parameter. A list of available parameters is on the :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` constants.
  1217. .. rst-class:: classref-item-separator
  1218. ----
  1219. .. _class_PhysicsServer3D_method_area_set_ray_pickable:
  1220. .. rst-class:: classref-method
  1221. |void| **area_set_ray_pickable**\ (\ area\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_set_ray_pickable>`
  1222. Sets object pickable with rays.
  1223. .. rst-class:: classref-item-separator
  1224. ----
  1225. .. _class_PhysicsServer3D_method_area_set_shape:
  1226. .. rst-class:: classref-method
  1227. |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>`
  1228. Substitutes a given area shape by another. The old shape is selected by its index, the new one by its :ref:`RID<class_RID>`.
  1229. .. rst-class:: classref-item-separator
  1230. ----
  1231. .. _class_PhysicsServer3D_method_area_set_shape_disabled:
  1232. .. rst-class:: classref-method
  1233. |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>`
  1234. .. container:: contribute
  1235. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1236. .. rst-class:: classref-item-separator
  1237. ----
  1238. .. _class_PhysicsServer3D_method_area_set_shape_transform:
  1239. .. rst-class:: classref-method
  1240. |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>`
  1241. Sets the transform matrix for an area shape.
  1242. .. rst-class:: classref-item-separator
  1243. ----
  1244. .. _class_PhysicsServer3D_method_area_set_space:
  1245. .. rst-class:: classref-method
  1246. |void| **area_set_space**\ (\ area\: :ref:`RID<class_RID>`, space\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_set_space>`
  1247. Assigns a space to the area.
  1248. .. rst-class:: classref-item-separator
  1249. ----
  1250. .. _class_PhysicsServer3D_method_area_set_transform:
  1251. .. rst-class:: classref-method
  1252. |void| **area_set_transform**\ (\ area\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_area_set_transform>`
  1253. Sets the transform matrix for an area.
  1254. .. rst-class:: classref-item-separator
  1255. ----
  1256. .. _class_PhysicsServer3D_method_body_add_collision_exception:
  1257. .. rst-class:: classref-method
  1258. |void| **body_add_collision_exception**\ (\ body\: :ref:`RID<class_RID>`, excepted_body\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_add_collision_exception>`
  1259. Adds a body to the list of bodies exempt from collisions.
  1260. .. rst-class:: classref-item-separator
  1261. ----
  1262. .. _class_PhysicsServer3D_method_body_add_constant_central_force:
  1263. .. rst-class:: classref-method
  1264. |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>`
  1265. 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))``.
  1266. This is equivalent to using :ref:`body_add_constant_force<class_PhysicsServer3D_method_body_add_constant_force>` at the body's center of mass.
  1267. .. rst-class:: classref-item-separator
  1268. ----
  1269. .. _class_PhysicsServer3D_method_body_add_constant_force:
  1270. .. rst-class:: classref-method
  1271. |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>`
  1272. 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))``.
  1273. \ ``position`` is the offset from the body origin in global coordinates.
  1274. .. rst-class:: classref-item-separator
  1275. ----
  1276. .. _class_PhysicsServer3D_method_body_add_constant_torque:
  1277. .. rst-class:: classref-method
  1278. |void| **body_add_constant_torque**\ (\ body\: :ref:`RID<class_RID>`, torque\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_add_constant_torque>`
  1279. 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))``.
  1280. .. rst-class:: classref-item-separator
  1281. ----
  1282. .. _class_PhysicsServer3D_method_body_add_shape:
  1283. .. rst-class:: classref-method
  1284. |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>`
  1285. 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.
  1286. .. rst-class:: classref-item-separator
  1287. ----
  1288. .. _class_PhysicsServer3D_method_body_apply_central_force:
  1289. .. rst-class:: classref-method
  1290. |void| **body_apply_central_force**\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_apply_central_force>`
  1291. Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update.
  1292. This is equivalent to using :ref:`body_apply_force<class_PhysicsServer3D_method_body_apply_force>` at the body's center of mass.
  1293. .. rst-class:: classref-item-separator
  1294. ----
  1295. .. _class_PhysicsServer3D_method_body_apply_central_impulse:
  1296. .. rst-class:: classref-method
  1297. |void| **body_apply_central_impulse**\ (\ body\: :ref:`RID<class_RID>`, impulse\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_apply_central_impulse>`
  1298. Applies a directional impulse without affecting rotation.
  1299. 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).
  1300. This is equivalent to using :ref:`body_apply_impulse<class_PhysicsServer3D_method_body_apply_impulse>` at the body's center of mass.
  1301. .. rst-class:: classref-item-separator
  1302. ----
  1303. .. _class_PhysicsServer3D_method_body_apply_force:
  1304. .. rst-class:: classref-method
  1305. |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>`
  1306. Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update.
  1307. \ ``position`` is the offset from the body origin in global coordinates.
  1308. .. rst-class:: classref-item-separator
  1309. ----
  1310. .. _class_PhysicsServer3D_method_body_apply_impulse:
  1311. .. rst-class:: classref-method
  1312. |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>`
  1313. Applies a positioned impulse to the body.
  1314. 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).
  1315. \ ``position`` is the offset from the body origin in global coordinates.
  1316. .. rst-class:: classref-item-separator
  1317. ----
  1318. .. _class_PhysicsServer3D_method_body_apply_torque:
  1319. .. rst-class:: classref-method
  1320. |void| **body_apply_torque**\ (\ body\: :ref:`RID<class_RID>`, torque\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_apply_torque>`
  1321. Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update.
  1322. .. rst-class:: classref-item-separator
  1323. ----
  1324. .. _class_PhysicsServer3D_method_body_apply_torque_impulse:
  1325. .. rst-class:: classref-method
  1326. |void| **body_apply_torque_impulse**\ (\ body\: :ref:`RID<class_RID>`, impulse\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_apply_torque_impulse>`
  1327. Applies a rotational impulse to the body without affecting the position.
  1328. 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).
  1329. .. rst-class:: classref-item-separator
  1330. ----
  1331. .. _class_PhysicsServer3D_method_body_attach_object_instance_id:
  1332. .. rst-class:: classref-method
  1333. |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>`
  1334. Assigns the area to a descendant of :ref:`Object<class_Object>`, so it can exist in the node tree.
  1335. .. rst-class:: classref-item-separator
  1336. ----
  1337. .. _class_PhysicsServer3D_method_body_clear_shapes:
  1338. .. rst-class:: classref-method
  1339. |void| **body_clear_shapes**\ (\ body\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_clear_shapes>`
  1340. Removes all shapes from a body.
  1341. .. rst-class:: classref-item-separator
  1342. ----
  1343. .. _class_PhysicsServer3D_method_body_create:
  1344. .. rst-class:: classref-method
  1345. :ref:`RID<class_RID>` **body_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_create>`
  1346. 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>`.
  1347. 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.
  1348. .. rst-class:: classref-item-separator
  1349. ----
  1350. .. _class_PhysicsServer3D_method_body_get_collision_layer:
  1351. .. rst-class:: classref-method
  1352. :ref:`int<class_int>` **body_get_collision_layer**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_collision_layer>`
  1353. Returns the physics layer or layers a body belongs to.
  1354. .. rst-class:: classref-item-separator
  1355. ----
  1356. .. _class_PhysicsServer3D_method_body_get_collision_mask:
  1357. .. rst-class:: classref-method
  1358. :ref:`int<class_int>` **body_get_collision_mask**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_collision_mask>`
  1359. Returns the physics layer or layers a body can collide with.
  1360. .. rst-class:: classref-item-separator
  1361. ----
  1362. .. _class_PhysicsServer3D_method_body_get_collision_priority:
  1363. .. rst-class:: classref-method
  1364. :ref:`float<class_float>` **body_get_collision_priority**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_collision_priority>`
  1365. Returns the body's collision priority.
  1366. .. rst-class:: classref-item-separator
  1367. ----
  1368. .. _class_PhysicsServer3D_method_body_get_constant_force:
  1369. .. rst-class:: classref-method
  1370. :ref:`Vector3<class_Vector3>` **body_get_constant_force**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_constant_force>`
  1371. Returns the body's total constant positional forces applied during each physics update.
  1372. 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>`.
  1373. .. rst-class:: classref-item-separator
  1374. ----
  1375. .. _class_PhysicsServer3D_method_body_get_constant_torque:
  1376. .. rst-class:: classref-method
  1377. :ref:`Vector3<class_Vector3>` **body_get_constant_torque**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_constant_torque>`
  1378. Returns the body's total constant rotational forces applied during each physics update.
  1379. See :ref:`body_add_constant_torque<class_PhysicsServer3D_method_body_add_constant_torque>`.
  1380. .. rst-class:: classref-item-separator
  1381. ----
  1382. .. _class_PhysicsServer3D_method_body_get_direct_state:
  1383. .. rst-class:: classref-method
  1384. :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>` **body_get_direct_state**\ (\ body\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_direct_state>`
  1385. Returns the :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>` of the body. Returns ``null`` if the body is destroyed or removed from the physics space.
  1386. .. rst-class:: classref-item-separator
  1387. ----
  1388. .. _class_PhysicsServer3D_method_body_get_max_contacts_reported:
  1389. .. rst-class:: classref-method
  1390. :ref:`int<class_int>` **body_get_max_contacts_reported**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_max_contacts_reported>`
  1391. Returns the maximum contacts that can be reported. See :ref:`body_set_max_contacts_reported<class_PhysicsServer3D_method_body_set_max_contacts_reported>`.
  1392. .. rst-class:: classref-item-separator
  1393. ----
  1394. .. _class_PhysicsServer3D_method_body_get_mode:
  1395. .. rst-class:: classref-method
  1396. :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **body_get_mode**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_mode>`
  1397. Returns the body mode.
  1398. .. rst-class:: classref-item-separator
  1399. ----
  1400. .. _class_PhysicsServer3D_method_body_get_object_instance_id:
  1401. .. rst-class:: classref-method
  1402. :ref:`int<class_int>` **body_get_object_instance_id**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_object_instance_id>`
  1403. Gets the instance ID of the object the area is assigned to.
  1404. .. rst-class:: classref-item-separator
  1405. ----
  1406. .. _class_PhysicsServer3D_method_body_get_param:
  1407. .. rst-class:: classref-method
  1408. :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>`
  1409. Returns the value of a body parameter. A list of available parameters is on the :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` constants.
  1410. .. rst-class:: classref-item-separator
  1411. ----
  1412. .. _class_PhysicsServer3D_method_body_get_shape:
  1413. .. rst-class:: classref-method
  1414. :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>`
  1415. Returns the :ref:`RID<class_RID>` of the nth shape of a body.
  1416. .. rst-class:: classref-item-separator
  1417. ----
  1418. .. _class_PhysicsServer3D_method_body_get_shape_count:
  1419. .. rst-class:: classref-method
  1420. :ref:`int<class_int>` **body_get_shape_count**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_shape_count>`
  1421. Returns the number of shapes assigned to a body.
  1422. .. rst-class:: classref-item-separator
  1423. ----
  1424. .. _class_PhysicsServer3D_method_body_get_shape_transform:
  1425. .. rst-class:: classref-method
  1426. :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>`
  1427. Returns the transform matrix of a body shape.
  1428. .. rst-class:: classref-item-separator
  1429. ----
  1430. .. _class_PhysicsServer3D_method_body_get_space:
  1431. .. rst-class:: classref-method
  1432. :ref:`RID<class_RID>` **body_get_space**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_get_space>`
  1433. Returns the :ref:`RID<class_RID>` of the space assigned to a body.
  1434. .. rst-class:: classref-item-separator
  1435. ----
  1436. .. _class_PhysicsServer3D_method_body_get_state:
  1437. .. rst-class:: classref-method
  1438. :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>`
  1439. Returns a body state.
  1440. .. rst-class:: classref-item-separator
  1441. ----
  1442. .. _class_PhysicsServer3D_method_body_is_axis_locked:
  1443. .. rst-class:: classref-method
  1444. :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>`
  1445. .. container:: contribute
  1446. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1447. .. rst-class:: classref-item-separator
  1448. ----
  1449. .. _class_PhysicsServer3D_method_body_is_continuous_collision_detection_enabled:
  1450. .. rst-class:: classref-method
  1451. :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>`
  1452. If ``true``, the continuous collision detection mode is enabled.
  1453. .. rst-class:: classref-item-separator
  1454. ----
  1455. .. _class_PhysicsServer3D_method_body_is_omitting_force_integration:
  1456. .. rst-class:: classref-method
  1457. :ref:`bool<class_bool>` **body_is_omitting_force_integration**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_is_omitting_force_integration>`
  1458. 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>`.
  1459. .. rst-class:: classref-item-separator
  1460. ----
  1461. .. _class_PhysicsServer3D_method_body_remove_collision_exception:
  1462. .. rst-class:: classref-method
  1463. |void| **body_remove_collision_exception**\ (\ body\: :ref:`RID<class_RID>`, excepted_body\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_remove_collision_exception>`
  1464. Removes a body from the list of bodies exempt from collisions.
  1465. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
  1466. .. rst-class:: classref-item-separator
  1467. ----
  1468. .. _class_PhysicsServer3D_method_body_remove_shape:
  1469. .. rst-class:: classref-method
  1470. |void| **body_remove_shape**\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_remove_shape>`
  1471. Removes a shape from a body. The shape is not deleted, so it can be reused afterwards.
  1472. .. rst-class:: classref-item-separator
  1473. ----
  1474. .. _class_PhysicsServer3D_method_body_reset_mass_properties:
  1475. .. rst-class:: classref-method
  1476. |void| **body_reset_mass_properties**\ (\ body\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_reset_mass_properties>`
  1477. 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>`.
  1478. .. rst-class:: classref-item-separator
  1479. ----
  1480. .. _class_PhysicsServer3D_method_body_set_axis_lock:
  1481. .. rst-class:: classref-method
  1482. |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>`
  1483. .. container:: contribute
  1484. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1485. .. rst-class:: classref-item-separator
  1486. ----
  1487. .. _class_PhysicsServer3D_method_body_set_axis_velocity:
  1488. .. rst-class:: classref-method
  1489. |void| **body_set_axis_velocity**\ (\ body\: :ref:`RID<class_RID>`, axis_velocity\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_axis_velocity>`
  1490. 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.
  1491. .. rst-class:: classref-item-separator
  1492. ----
  1493. .. _class_PhysicsServer3D_method_body_set_collision_layer:
  1494. .. rst-class:: classref-method
  1495. |void| **body_set_collision_layer**\ (\ body\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_collision_layer>`
  1496. Sets the physics layer or layers a body belongs to.
  1497. .. rst-class:: classref-item-separator
  1498. ----
  1499. .. _class_PhysicsServer3D_method_body_set_collision_mask:
  1500. .. rst-class:: classref-method
  1501. |void| **body_set_collision_mask**\ (\ body\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_collision_mask>`
  1502. Sets the physics layer or layers a body can collide with.
  1503. .. rst-class:: classref-item-separator
  1504. ----
  1505. .. _class_PhysicsServer3D_method_body_set_collision_priority:
  1506. .. rst-class:: classref-method
  1507. |void| **body_set_collision_priority**\ (\ body\: :ref:`RID<class_RID>`, priority\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_collision_priority>`
  1508. Sets the body's collision priority.
  1509. .. rst-class:: classref-item-separator
  1510. ----
  1511. .. _class_PhysicsServer3D_method_body_set_constant_force:
  1512. .. rst-class:: classref-method
  1513. |void| **body_set_constant_force**\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_constant_force>`
  1514. Sets the body's total constant positional forces applied during each physics update.
  1515. 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>`.
  1516. .. rst-class:: classref-item-separator
  1517. ----
  1518. .. _class_PhysicsServer3D_method_body_set_constant_torque:
  1519. .. rst-class:: classref-method
  1520. |void| **body_set_constant_torque**\ (\ body\: :ref:`RID<class_RID>`, torque\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_constant_torque>`
  1521. Sets the body's total constant rotational forces applied during each physics update.
  1522. See :ref:`body_add_constant_torque<class_PhysicsServer3D_method_body_add_constant_torque>`.
  1523. .. rst-class:: classref-item-separator
  1524. ----
  1525. .. _class_PhysicsServer3D_method_body_set_enable_continuous_collision_detection:
  1526. .. rst-class:: classref-method
  1527. |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>`
  1528. If ``true``, the continuous collision detection mode is enabled.
  1529. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
  1530. .. rst-class:: classref-item-separator
  1531. ----
  1532. .. _class_PhysicsServer3D_method_body_set_force_integration_callback:
  1533. .. rst-class:: classref-method
  1534. |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>`
  1535. Sets the body's custom force integration callback function to ``callable``. Use an empty :ref:`Callable<class_Callable>` (``Callable()``) to clear the custom callback.
  1536. 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.
  1537. If ``userdata`` is not ``null``, the function ``callable`` must take the following two parameters:
  1538. 1. ``state``: a :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>`, used to retrieve and modify the body's state,
  1539. 2. ``userdata``: a :ref:`Variant<class_Variant>`; its value will be the ``userdata`` passed into this method.
  1540. If ``userdata`` is ``null``, then ``callable`` must take only the ``state`` parameter.
  1541. .. rst-class:: classref-item-separator
  1542. ----
  1543. .. _class_PhysicsServer3D_method_body_set_max_contacts_reported:
  1544. .. rst-class:: classref-method
  1545. |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>`
  1546. 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.
  1547. .. rst-class:: classref-item-separator
  1548. ----
  1549. .. _class_PhysicsServer3D_method_body_set_mode:
  1550. .. rst-class:: classref-method
  1551. |void| **body_set_mode**\ (\ body\: :ref:`RID<class_RID>`, mode\: :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_mode>`
  1552. Sets the body mode, from one of the :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` constants.
  1553. .. rst-class:: classref-item-separator
  1554. ----
  1555. .. _class_PhysicsServer3D_method_body_set_omit_force_integration:
  1556. .. rst-class:: classref-method
  1557. |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>`
  1558. 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.
  1559. This method is called when the property :ref:`RigidBody3D.custom_integrator<class_RigidBody3D_property_custom_integrator>` is set.
  1560. .. rst-class:: classref-item-separator
  1561. ----
  1562. .. _class_PhysicsServer3D_method_body_set_param:
  1563. .. rst-class:: classref-method
  1564. |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>`
  1565. Sets a body parameter. A list of available parameters is on the :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` constants.
  1566. .. rst-class:: classref-item-separator
  1567. ----
  1568. .. _class_PhysicsServer3D_method_body_set_ray_pickable:
  1569. .. rst-class:: classref-method
  1570. |void| **body_set_ray_pickable**\ (\ body\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_ray_pickable>`
  1571. Sets the body pickable with rays if ``enable`` is set.
  1572. .. rst-class:: classref-item-separator
  1573. ----
  1574. .. _class_PhysicsServer3D_method_body_set_shape:
  1575. .. rst-class:: classref-method
  1576. |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>`
  1577. Substitutes a given body shape by another. The old shape is selected by its index, the new one by its :ref:`RID<class_RID>`.
  1578. .. rst-class:: classref-item-separator
  1579. ----
  1580. .. _class_PhysicsServer3D_method_body_set_shape_disabled:
  1581. .. rst-class:: classref-method
  1582. |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>`
  1583. .. container:: contribute
  1584. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1585. .. rst-class:: classref-item-separator
  1586. ----
  1587. .. _class_PhysicsServer3D_method_body_set_shape_transform:
  1588. .. rst-class:: classref-method
  1589. |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>`
  1590. Sets the transform matrix for a body shape.
  1591. .. rst-class:: classref-item-separator
  1592. ----
  1593. .. _class_PhysicsServer3D_method_body_set_space:
  1594. .. rst-class:: classref-method
  1595. |void| **body_set_space**\ (\ body\: :ref:`RID<class_RID>`, space\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_space>`
  1596. Assigns a space to the body (see :ref:`space_create<class_PhysicsServer3D_method_space_create>`).
  1597. .. rst-class:: classref-item-separator
  1598. ----
  1599. .. _class_PhysicsServer3D_method_body_set_state:
  1600. .. rst-class:: classref-method
  1601. |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>`
  1602. Sets a body state (see :ref:`BodyState<enum_PhysicsServer3D_BodyState>` constants).
  1603. .. rst-class:: classref-item-separator
  1604. ----
  1605. .. _class_PhysicsServer3D_method_body_set_state_sync_callback:
  1606. .. rst-class:: classref-method
  1607. |void| **body_set_state_sync_callback**\ (\ body\: :ref:`RID<class_RID>`, callable\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_body_set_state_sync_callback>`
  1608. Sets the body's state synchronization callback function to ``callable``. Use an empty :ref:`Callable<class_Callable>` (``Callable()``) to clear the callback.
  1609. The function ``callable`` will be called every physics frame, assuming that the body was active during the previous physics tick, and can be used to fetch the latest state from the physics server.
  1610. The function ``callable`` must take the following parameters:
  1611. 1. ``state``: a :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>`, used to retrieve the body's state.
  1612. .. rst-class:: classref-item-separator
  1613. ----
  1614. .. _class_PhysicsServer3D_method_body_test_motion:
  1615. .. rst-class:: classref-method
  1616. :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>`
  1617. 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.
  1618. .. rst-class:: classref-item-separator
  1619. ----
  1620. .. _class_PhysicsServer3D_method_box_shape_create:
  1621. .. rst-class:: classref-method
  1622. :ref:`RID<class_RID>` **box_shape_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_box_shape_create>`
  1623. .. container:: contribute
  1624. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1625. .. rst-class:: classref-item-separator
  1626. ----
  1627. .. _class_PhysicsServer3D_method_capsule_shape_create:
  1628. .. rst-class:: classref-method
  1629. :ref:`RID<class_RID>` **capsule_shape_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_capsule_shape_create>`
  1630. .. container:: contribute
  1631. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1632. .. rst-class:: classref-item-separator
  1633. ----
  1634. .. _class_PhysicsServer3D_method_concave_polygon_shape_create:
  1635. .. rst-class:: classref-method
  1636. :ref:`RID<class_RID>` **concave_polygon_shape_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_concave_polygon_shape_create>`
  1637. .. container:: contribute
  1638. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1639. .. rst-class:: classref-item-separator
  1640. ----
  1641. .. _class_PhysicsServer3D_method_cone_twist_joint_get_param:
  1642. .. rst-class:: classref-method
  1643. :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>`
  1644. Gets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` constants).
  1645. .. rst-class:: classref-item-separator
  1646. ----
  1647. .. _class_PhysicsServer3D_method_cone_twist_joint_set_param:
  1648. .. rst-class:: classref-method
  1649. |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>`
  1650. Sets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` constants).
  1651. .. rst-class:: classref-item-separator
  1652. ----
  1653. .. _class_PhysicsServer3D_method_convex_polygon_shape_create:
  1654. .. rst-class:: classref-method
  1655. :ref:`RID<class_RID>` **convex_polygon_shape_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_convex_polygon_shape_create>`
  1656. .. container:: contribute
  1657. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1658. .. rst-class:: classref-item-separator
  1659. ----
  1660. .. _class_PhysicsServer3D_method_custom_shape_create:
  1661. .. rst-class:: classref-method
  1662. :ref:`RID<class_RID>` **custom_shape_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_custom_shape_create>`
  1663. .. container:: contribute
  1664. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1665. .. rst-class:: classref-item-separator
  1666. ----
  1667. .. _class_PhysicsServer3D_method_cylinder_shape_create:
  1668. .. rst-class:: classref-method
  1669. :ref:`RID<class_RID>` **cylinder_shape_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_cylinder_shape_create>`
  1670. .. container:: contribute
  1671. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1672. .. rst-class:: classref-item-separator
  1673. ----
  1674. .. _class_PhysicsServer3D_method_free_rid:
  1675. .. rst-class:: classref-method
  1676. |void| **free_rid**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_free_rid>`
  1677. 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.
  1678. .. rst-class:: classref-item-separator
  1679. ----
  1680. .. _class_PhysicsServer3D_method_generic_6dof_joint_get_flag:
  1681. .. rst-class:: classref-method
  1682. :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>`
  1683. Returns the value of a generic 6DOF joint flag. See :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` for the list of available flags.
  1684. .. rst-class:: classref-item-separator
  1685. ----
  1686. .. _class_PhysicsServer3D_method_generic_6dof_joint_get_param:
  1687. .. rst-class:: classref-method
  1688. :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>`
  1689. Returns the value of a generic 6DOF joint parameter. See :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` for the list of available parameters.
  1690. .. rst-class:: classref-item-separator
  1691. ----
  1692. .. _class_PhysicsServer3D_method_generic_6dof_joint_set_flag:
  1693. .. rst-class:: classref-method
  1694. |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>`
  1695. Sets the value of a given generic 6DOF joint flag. See :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` for the list of available flags.
  1696. .. rst-class:: classref-item-separator
  1697. ----
  1698. .. _class_PhysicsServer3D_method_generic_6dof_joint_set_param:
  1699. .. rst-class:: classref-method
  1700. |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>`
  1701. Sets the value of a given generic 6DOF joint parameter. See :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` for the list of available parameters.
  1702. .. rst-class:: classref-item-separator
  1703. ----
  1704. .. _class_PhysicsServer3D_method_get_process_info:
  1705. .. rst-class:: classref-method
  1706. :ref:`int<class_int>` **get_process_info**\ (\ process_info\: :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_get_process_info>`
  1707. Returns information about the current state of the 3D physics engine. See :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>` for a list of available states.
  1708. .. rst-class:: classref-item-separator
  1709. ----
  1710. .. _class_PhysicsServer3D_method_heightmap_shape_create:
  1711. .. rst-class:: classref-method
  1712. :ref:`RID<class_RID>` **heightmap_shape_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_heightmap_shape_create>`
  1713. .. container:: contribute
  1714. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1715. .. rst-class:: classref-item-separator
  1716. ----
  1717. .. _class_PhysicsServer3D_method_hinge_joint_get_flag:
  1718. .. rst-class:: classref-method
  1719. :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>`
  1720. Gets a hinge_joint flag (see :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` constants).
  1721. .. rst-class:: classref-item-separator
  1722. ----
  1723. .. _class_PhysicsServer3D_method_hinge_joint_get_param:
  1724. .. rst-class:: classref-method
  1725. :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>`
  1726. Gets a hinge_joint parameter (see :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>`).
  1727. .. rst-class:: classref-item-separator
  1728. ----
  1729. .. _class_PhysicsServer3D_method_hinge_joint_set_flag:
  1730. .. rst-class:: classref-method
  1731. |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>`
  1732. Sets a hinge_joint flag (see :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` constants).
  1733. .. rst-class:: classref-item-separator
  1734. ----
  1735. .. _class_PhysicsServer3D_method_hinge_joint_set_param:
  1736. .. rst-class:: classref-method
  1737. |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>`
  1738. Sets a hinge_joint parameter (see :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` constants).
  1739. .. rst-class:: classref-item-separator
  1740. ----
  1741. .. _class_PhysicsServer3D_method_joint_clear:
  1742. .. rst-class:: classref-method
  1743. |void| **joint_clear**\ (\ joint\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_joint_clear>`
  1744. .. container:: contribute
  1745. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1746. .. rst-class:: classref-item-separator
  1747. ----
  1748. .. _class_PhysicsServer3D_method_joint_create:
  1749. .. rst-class:: classref-method
  1750. :ref:`RID<class_RID>` **joint_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_joint_create>`
  1751. .. container:: contribute
  1752. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1753. .. rst-class:: classref-item-separator
  1754. ----
  1755. .. _class_PhysicsServer3D_method_joint_disable_collisions_between_bodies:
  1756. .. rst-class:: classref-method
  1757. |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>`
  1758. Sets whether the bodies attached to the :ref:`Joint3D<class_Joint3D>` will collide with each other.
  1759. .. rst-class:: classref-item-separator
  1760. ----
  1761. .. _class_PhysicsServer3D_method_joint_get_solver_priority:
  1762. .. rst-class:: classref-method
  1763. :ref:`int<class_int>` **joint_get_solver_priority**\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_joint_get_solver_priority>`
  1764. Gets the priority value of the Joint3D.
  1765. .. rst-class:: classref-item-separator
  1766. ----
  1767. .. _class_PhysicsServer3D_method_joint_get_type:
  1768. .. rst-class:: classref-method
  1769. :ref:`JointType<enum_PhysicsServer3D_JointType>` **joint_get_type**\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_joint_get_type>`
  1770. Returns the type of the Joint3D.
  1771. .. rst-class:: classref-item-separator
  1772. ----
  1773. .. _class_PhysicsServer3D_method_joint_is_disabled_collisions_between_bodies:
  1774. .. rst-class:: classref-method
  1775. :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>`
  1776. Returns whether the bodies attached to the :ref:`Joint3D<class_Joint3D>` will collide with each other.
  1777. .. rst-class:: classref-item-separator
  1778. ----
  1779. .. _class_PhysicsServer3D_method_joint_make_cone_twist:
  1780. .. rst-class:: classref-method
  1781. |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>`
  1782. .. container:: contribute
  1783. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1784. .. rst-class:: classref-item-separator
  1785. ----
  1786. .. _class_PhysicsServer3D_method_joint_make_generic_6dof:
  1787. .. rst-class:: classref-method
  1788. |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>`
  1789. 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.
  1790. .. rst-class:: classref-item-separator
  1791. ----
  1792. .. _class_PhysicsServer3D_method_joint_make_hinge:
  1793. .. rst-class:: classref-method
  1794. |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>`
  1795. .. container:: contribute
  1796. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1797. .. rst-class:: classref-item-separator
  1798. ----
  1799. .. _class_PhysicsServer3D_method_joint_make_pin:
  1800. .. rst-class:: classref-method
  1801. |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>`
  1802. .. container:: contribute
  1803. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1804. .. rst-class:: classref-item-separator
  1805. ----
  1806. .. _class_PhysicsServer3D_method_joint_make_slider:
  1807. .. rst-class:: classref-method
  1808. |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>`
  1809. .. container:: contribute
  1810. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1811. .. rst-class:: classref-item-separator
  1812. ----
  1813. .. _class_PhysicsServer3D_method_joint_set_solver_priority:
  1814. .. rst-class:: classref-method
  1815. |void| **joint_set_solver_priority**\ (\ joint\: :ref:`RID<class_RID>`, priority\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_joint_set_solver_priority>`
  1816. Sets the priority value of the Joint3D.
  1817. .. rst-class:: classref-item-separator
  1818. ----
  1819. .. _class_PhysicsServer3D_method_pin_joint_get_local_a:
  1820. .. rst-class:: classref-method
  1821. :ref:`Vector3<class_Vector3>` **pin_joint_get_local_a**\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_pin_joint_get_local_a>`
  1822. Returns position of the joint in the local space of body a of the joint.
  1823. .. rst-class:: classref-item-separator
  1824. ----
  1825. .. _class_PhysicsServer3D_method_pin_joint_get_local_b:
  1826. .. rst-class:: classref-method
  1827. :ref:`Vector3<class_Vector3>` **pin_joint_get_local_b**\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_pin_joint_get_local_b>`
  1828. Returns position of the joint in the local space of body b of the joint.
  1829. .. rst-class:: classref-item-separator
  1830. ----
  1831. .. _class_PhysicsServer3D_method_pin_joint_get_param:
  1832. .. rst-class:: classref-method
  1833. :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>`
  1834. Gets a pin_joint parameter (see :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` constants).
  1835. .. rst-class:: classref-item-separator
  1836. ----
  1837. .. _class_PhysicsServer3D_method_pin_joint_set_local_a:
  1838. .. rst-class:: classref-method
  1839. |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>`
  1840. Sets position of the joint in the local space of body a of the joint.
  1841. .. rst-class:: classref-item-separator
  1842. ----
  1843. .. _class_PhysicsServer3D_method_pin_joint_set_local_b:
  1844. .. rst-class:: classref-method
  1845. |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>`
  1846. Sets position of the joint in the local space of body b of the joint.
  1847. .. rst-class:: classref-item-separator
  1848. ----
  1849. .. _class_PhysicsServer3D_method_pin_joint_set_param:
  1850. .. rst-class:: classref-method
  1851. |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>`
  1852. Sets a pin_joint parameter (see :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` constants).
  1853. .. rst-class:: classref-item-separator
  1854. ----
  1855. .. _class_PhysicsServer3D_method_separation_ray_shape_create:
  1856. .. rst-class:: classref-method
  1857. :ref:`RID<class_RID>` **separation_ray_shape_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_separation_ray_shape_create>`
  1858. .. container:: contribute
  1859. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1860. .. rst-class:: classref-item-separator
  1861. ----
  1862. .. _class_PhysicsServer3D_method_set_active:
  1863. .. rst-class:: classref-method
  1864. |void| **set_active**\ (\ active\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_set_active>`
  1865. Activates or deactivates the 3D physics engine.
  1866. .. rst-class:: classref-item-separator
  1867. ----
  1868. .. _class_PhysicsServer3D_method_shape_get_data:
  1869. .. rst-class:: classref-method
  1870. :ref:`Variant<class_Variant>` **shape_get_data**\ (\ shape\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_shape_get_data>`
  1871. Returns the shape data.
  1872. .. rst-class:: classref-item-separator
  1873. ----
  1874. .. _class_PhysicsServer3D_method_shape_get_margin:
  1875. .. rst-class:: classref-method
  1876. :ref:`float<class_float>` **shape_get_margin**\ (\ shape\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_shape_get_margin>`
  1877. Returns the collision margin for the shape.
  1878. \ **Note:** This is not used in Godot Physics, so will always return ``0``.
  1879. .. rst-class:: classref-item-separator
  1880. ----
  1881. .. _class_PhysicsServer3D_method_shape_get_type:
  1882. .. rst-class:: classref-method
  1883. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **shape_get_type**\ (\ shape\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_shape_get_type>`
  1884. Returns the type of shape (see :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` constants).
  1885. .. rst-class:: classref-item-separator
  1886. ----
  1887. .. _class_PhysicsServer3D_method_shape_set_data:
  1888. .. rst-class:: classref-method
  1889. |void| **shape_set_data**\ (\ shape\: :ref:`RID<class_RID>`, data\: :ref:`Variant<class_Variant>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_shape_set_data>`
  1890. 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>`.
  1891. .. rst-class:: classref-item-separator
  1892. ----
  1893. .. _class_PhysicsServer3D_method_shape_set_margin:
  1894. .. rst-class:: classref-method
  1895. |void| **shape_set_margin**\ (\ shape\: :ref:`RID<class_RID>`, margin\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_shape_set_margin>`
  1896. Sets the collision margin for the shape.
  1897. \ **Note:** This is not used in Godot Physics.
  1898. .. rst-class:: classref-item-separator
  1899. ----
  1900. .. _class_PhysicsServer3D_method_slider_joint_get_param:
  1901. .. rst-class:: classref-method
  1902. :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>`
  1903. Gets a slider_joint parameter (see :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` constants).
  1904. .. rst-class:: classref-item-separator
  1905. ----
  1906. .. _class_PhysicsServer3D_method_slider_joint_set_param:
  1907. .. rst-class:: classref-method
  1908. |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>`
  1909. Gets a slider_joint parameter (see :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` constants).
  1910. .. rst-class:: classref-item-separator
  1911. ----
  1912. .. _class_PhysicsServer3D_method_soft_body_add_collision_exception:
  1913. .. rst-class:: classref-method
  1914. |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>`
  1915. Adds the given body to the list of bodies exempt from collisions.
  1916. .. rst-class:: classref-item-separator
  1917. ----
  1918. .. _class_PhysicsServer3D_method_soft_body_create:
  1919. .. rst-class:: classref-method
  1920. :ref:`RID<class_RID>` **soft_body_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_create>`
  1921. Creates a new soft body and returns its internal :ref:`RID<class_RID>`.
  1922. .. rst-class:: classref-item-separator
  1923. ----
  1924. .. _class_PhysicsServer3D_method_soft_body_get_bounds:
  1925. .. rst-class:: classref-method
  1926. :ref:`AABB<class_AABB>` **soft_body_get_bounds**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_bounds>`
  1927. Returns the bounds of the given soft body in global coordinates.
  1928. .. rst-class:: classref-item-separator
  1929. ----
  1930. .. _class_PhysicsServer3D_method_soft_body_get_collision_layer:
  1931. .. rst-class:: classref-method
  1932. :ref:`int<class_int>` **soft_body_get_collision_layer**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_collision_layer>`
  1933. Returns the physics layer or layers that the given soft body belongs to.
  1934. .. rst-class:: classref-item-separator
  1935. ----
  1936. .. _class_PhysicsServer3D_method_soft_body_get_collision_mask:
  1937. .. rst-class:: classref-method
  1938. :ref:`int<class_int>` **soft_body_get_collision_mask**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_collision_mask>`
  1939. Returns the physics layer or layers that the given soft body can collide with.
  1940. .. rst-class:: classref-item-separator
  1941. ----
  1942. .. _class_PhysicsServer3D_method_soft_body_get_damping_coefficient:
  1943. .. rst-class:: classref-method
  1944. :ref:`float<class_float>` **soft_body_get_damping_coefficient**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_damping_coefficient>`
  1945. Returns the damping coefficient of the given soft body.
  1946. .. rst-class:: classref-item-separator
  1947. ----
  1948. .. _class_PhysicsServer3D_method_soft_body_get_drag_coefficient:
  1949. .. rst-class:: classref-method
  1950. :ref:`float<class_float>` **soft_body_get_drag_coefficient**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_drag_coefficient>`
  1951. Returns the drag coefficient of the given soft body.
  1952. .. rst-class:: classref-item-separator
  1953. ----
  1954. .. _class_PhysicsServer3D_method_soft_body_get_linear_stiffness:
  1955. .. rst-class:: classref-method
  1956. :ref:`float<class_float>` **soft_body_get_linear_stiffness**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_linear_stiffness>`
  1957. Returns the linear stiffness of the given soft body.
  1958. .. rst-class:: classref-item-separator
  1959. ----
  1960. .. _class_PhysicsServer3D_method_soft_body_get_point_global_position:
  1961. .. rst-class:: classref-method
  1962. :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>`
  1963. Returns the current position of the given soft body point in global coordinates.
  1964. .. rst-class:: classref-item-separator
  1965. ----
  1966. .. _class_PhysicsServer3D_method_soft_body_get_pressure_coefficient:
  1967. .. rst-class:: classref-method
  1968. :ref:`float<class_float>` **soft_body_get_pressure_coefficient**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_pressure_coefficient>`
  1969. Returns the pressure coefficient of the given soft body.
  1970. .. rst-class:: classref-item-separator
  1971. ----
  1972. .. _class_PhysicsServer3D_method_soft_body_get_simulation_precision:
  1973. .. rst-class:: classref-method
  1974. :ref:`int<class_int>` **soft_body_get_simulation_precision**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_simulation_precision>`
  1975. Returns the simulation precision of the given soft body.
  1976. .. rst-class:: classref-item-separator
  1977. ----
  1978. .. _class_PhysicsServer3D_method_soft_body_get_space:
  1979. .. rst-class:: classref-method
  1980. :ref:`RID<class_RID>` **soft_body_get_space**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_space>`
  1981. Returns the :ref:`RID<class_RID>` of the space assigned to the given soft body.
  1982. .. rst-class:: classref-item-separator
  1983. ----
  1984. .. _class_PhysicsServer3D_method_soft_body_get_state:
  1985. .. rst-class:: classref-method
  1986. :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>`
  1987. Returns the given soft body state (see :ref:`BodyState<enum_PhysicsServer3D_BodyState>` constants).
  1988. \ **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>`.
  1989. .. rst-class:: classref-item-separator
  1990. ----
  1991. .. _class_PhysicsServer3D_method_soft_body_get_total_mass:
  1992. .. rst-class:: classref-method
  1993. :ref:`float<class_float>` **soft_body_get_total_mass**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_get_total_mass>`
  1994. Returns the total mass assigned to the given soft body.
  1995. .. rst-class:: classref-item-separator
  1996. ----
  1997. .. _class_PhysicsServer3D_method_soft_body_is_point_pinned:
  1998. .. rst-class:: classref-method
  1999. :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>`
  2000. Returns whether the given soft body point is pinned.
  2001. .. rst-class:: classref-item-separator
  2002. ----
  2003. .. _class_PhysicsServer3D_method_soft_body_move_point:
  2004. .. rst-class:: classref-method
  2005. |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>`
  2006. Moves the given soft body point to a position in global coordinates.
  2007. .. rst-class:: classref-item-separator
  2008. ----
  2009. .. _class_PhysicsServer3D_method_soft_body_pin_point:
  2010. .. rst-class:: classref-method
  2011. |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>`
  2012. Pins or unpins the given soft body point based on the value of ``pin``.
  2013. \ **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>`.
  2014. .. rst-class:: classref-item-separator
  2015. ----
  2016. .. _class_PhysicsServer3D_method_soft_body_remove_all_pinned_points:
  2017. .. rst-class:: classref-method
  2018. |void| **soft_body_remove_all_pinned_points**\ (\ body\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_remove_all_pinned_points>`
  2019. Unpins all points of the given soft body.
  2020. .. rst-class:: classref-item-separator
  2021. ----
  2022. .. _class_PhysicsServer3D_method_soft_body_remove_collision_exception:
  2023. .. rst-class:: classref-method
  2024. |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>`
  2025. Removes the given body from the list of bodies exempt from collisions.
  2026. .. rst-class:: classref-item-separator
  2027. ----
  2028. .. _class_PhysicsServer3D_method_soft_body_set_collision_layer:
  2029. .. rst-class:: classref-method
  2030. |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>`
  2031. Sets the physics layer or layers the given soft body belongs to.
  2032. .. rst-class:: classref-item-separator
  2033. ----
  2034. .. _class_PhysicsServer3D_method_soft_body_set_collision_mask:
  2035. .. rst-class:: classref-method
  2036. |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>`
  2037. Sets the physics layer or layers the given soft body can collide with.
  2038. .. rst-class:: classref-item-separator
  2039. ----
  2040. .. _class_PhysicsServer3D_method_soft_body_set_damping_coefficient:
  2041. .. rst-class:: classref-method
  2042. |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>`
  2043. Sets the damping coefficient of the given soft body. Higher values will slow down the body more noticeably when forces are applied.
  2044. .. rst-class:: classref-item-separator
  2045. ----
  2046. .. _class_PhysicsServer3D_method_soft_body_set_drag_coefficient:
  2047. .. rst-class:: classref-method
  2048. |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>`
  2049. Sets the drag coefficient of the given soft body. Higher values increase this body's air resistance.
  2050. \ **Note:** This value is currently unused by Godot's default physics implementation.
  2051. .. rst-class:: classref-item-separator
  2052. ----
  2053. .. _class_PhysicsServer3D_method_soft_body_set_linear_stiffness:
  2054. .. rst-class:: classref-method
  2055. |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>`
  2056. 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).
  2057. .. rst-class:: classref-item-separator
  2058. ----
  2059. .. _class_PhysicsServer3D_method_soft_body_set_mesh:
  2060. .. rst-class:: classref-method
  2061. |void| **soft_body_set_mesh**\ (\ body\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_set_mesh>`
  2062. Sets the mesh of the given soft body.
  2063. .. rst-class:: classref-item-separator
  2064. ----
  2065. .. _class_PhysicsServer3D_method_soft_body_set_pressure_coefficient:
  2066. .. rst-class:: classref-method
  2067. |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>`
  2068. 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.
  2069. .. rst-class:: classref-item-separator
  2070. ----
  2071. .. _class_PhysicsServer3D_method_soft_body_set_ray_pickable:
  2072. .. rst-class:: classref-method
  2073. |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>`
  2074. Sets whether the given soft body will be pickable when using object picking.
  2075. .. rst-class:: classref-item-separator
  2076. ----
  2077. .. _class_PhysicsServer3D_method_soft_body_set_simulation_precision:
  2078. .. rst-class:: classref-method
  2079. |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>`
  2080. Sets the simulation precision of the given soft body. Increasing this value will improve the resulting simulation, but can affect performance. Use with care.
  2081. .. rst-class:: classref-item-separator
  2082. ----
  2083. .. _class_PhysicsServer3D_method_soft_body_set_space:
  2084. .. rst-class:: classref-method
  2085. |void| **soft_body_set_space**\ (\ body\: :ref:`RID<class_RID>`, space\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_set_space>`
  2086. Assigns a space to the given soft body (see :ref:`space_create<class_PhysicsServer3D_method_space_create>`).
  2087. .. rst-class:: classref-item-separator
  2088. ----
  2089. .. _class_PhysicsServer3D_method_soft_body_set_state:
  2090. .. rst-class:: classref-method
  2091. |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>`
  2092. Sets the given body state for the given body (see :ref:`BodyState<enum_PhysicsServer3D_BodyState>` constants).
  2093. \ **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>`.
  2094. .. rst-class:: classref-item-separator
  2095. ----
  2096. .. _class_PhysicsServer3D_method_soft_body_set_total_mass:
  2097. .. rst-class:: classref-method
  2098. |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>`
  2099. Sets the total mass for the given soft body.
  2100. .. rst-class:: classref-item-separator
  2101. ----
  2102. .. _class_PhysicsServer3D_method_soft_body_set_transform:
  2103. .. rst-class:: classref-method
  2104. |void| **soft_body_set_transform**\ (\ body\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_soft_body_set_transform>`
  2105. Sets the global transform of the given soft body.
  2106. .. rst-class:: classref-item-separator
  2107. ----
  2108. .. _class_PhysicsServer3D_method_soft_body_update_rendering_server:
  2109. .. rst-class:: classref-method
  2110. |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>`
  2111. 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.
  2112. .. rst-class:: classref-item-separator
  2113. ----
  2114. .. _class_PhysicsServer3D_method_space_create:
  2115. .. rst-class:: classref-method
  2116. :ref:`RID<class_RID>` **space_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_space_create>`
  2117. 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>`.
  2118. .. rst-class:: classref-item-separator
  2119. ----
  2120. .. _class_PhysicsServer3D_method_space_get_direct_state:
  2121. .. rst-class:: classref-method
  2122. :ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>` **space_get_direct_state**\ (\ space\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_space_get_direct_state>`
  2123. Returns the state of a space, a :ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>`. This object can be used to make collision/intersection queries.
  2124. .. rst-class:: classref-item-separator
  2125. ----
  2126. .. _class_PhysicsServer3D_method_space_get_param:
  2127. .. rst-class:: classref-method
  2128. :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>`
  2129. Returns the value of a space parameter.
  2130. .. rst-class:: classref-item-separator
  2131. ----
  2132. .. _class_PhysicsServer3D_method_space_is_active:
  2133. .. rst-class:: classref-method
  2134. :ref:`bool<class_bool>` **space_is_active**\ (\ space\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_PhysicsServer3D_method_space_is_active>`
  2135. Returns whether the space is active.
  2136. .. rst-class:: classref-item-separator
  2137. ----
  2138. .. _class_PhysicsServer3D_method_space_set_active:
  2139. .. rst-class:: classref-method
  2140. |void| **space_set_active**\ (\ space\: :ref:`RID<class_RID>`, active\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_space_set_active>`
  2141. Marks a space as active. It will not have an effect, unless it is assigned to an area or body.
  2142. .. rst-class:: classref-item-separator
  2143. ----
  2144. .. _class_PhysicsServer3D_method_space_set_param:
  2145. .. rst-class:: classref-method
  2146. |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>`
  2147. Sets the value for a space parameter. A list of available parameters is on the :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` constants.
  2148. .. rst-class:: classref-item-separator
  2149. ----
  2150. .. _class_PhysicsServer3D_method_sphere_shape_create:
  2151. .. rst-class:: classref-method
  2152. :ref:`RID<class_RID>` **sphere_shape_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_sphere_shape_create>`
  2153. .. container:: contribute
  2154. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2155. .. rst-class:: classref-item-separator
  2156. ----
  2157. .. _class_PhysicsServer3D_method_world_boundary_shape_create:
  2158. .. rst-class:: classref-method
  2159. :ref:`RID<class_RID>` **world_boundary_shape_create**\ (\ ) :ref:`๐Ÿ”—<class_PhysicsServer3D_method_world_boundary_shape_create>`
  2160. .. container:: contribute
  2161. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2162. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  2163. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  2164. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  2165. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  2166. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  2167. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  2168. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  2169. .. |void| replace:: :abbr:`void (No return value.)`