class_physicsserver3d.rst 195 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360
  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/4.1/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.1/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>` **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` shape, :ref:`Transform3D<class_Transform3D>` transform=Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), :ref:`bool<class_bool>` disabled=false **)** |
  30. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | void | :ref:`area_attach_object_instance_id<class_PhysicsServer3D_method_area_attach_object_instance_id>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)** |
  32. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | void | :ref:`area_clear_shapes<class_PhysicsServer3D_method_area_clear_shapes>` **(** :ref:`RID<class_RID>` area **)** |
  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>` **(** :ref:`RID<class_RID>` area **)** |const| |
  38. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | :ref:`int<class_int>` | :ref:`area_get_collision_mask<class_PhysicsServer3D_method_area_get_collision_mask>` **(** :ref:`RID<class_RID>` area **)** |const| |
  40. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`int<class_int>` | :ref:`area_get_object_instance_id<class_PhysicsServer3D_method_area_get_object_instance_id>` **(** :ref:`RID<class_RID>` area **)** |const| |
  42. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | :ref:`Variant<class_Variant>` | :ref:`area_get_param<class_PhysicsServer3D_method_area_get_param>` **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` param **)** |const| |
  44. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | :ref:`RID<class_RID>` | :ref:`area_get_shape<class_PhysicsServer3D_method_area_get_shape>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |const| |
  46. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | :ref:`int<class_int>` | :ref:`area_get_shape_count<class_PhysicsServer3D_method_area_get_shape_count>` **(** :ref:`RID<class_RID>` area **)** |const| |
  48. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | :ref:`Transform3D<class_Transform3D>` | :ref:`area_get_shape_transform<class_PhysicsServer3D_method_area_get_shape_transform>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |const| |
  50. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | :ref:`RID<class_RID>` | :ref:`area_get_space<class_PhysicsServer3D_method_area_get_space>` **(** :ref:`RID<class_RID>` area **)** |const| |
  52. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | :ref:`Transform3D<class_Transform3D>` | :ref:`area_get_transform<class_PhysicsServer3D_method_area_get_transform>` **(** :ref:`RID<class_RID>` area **)** |const| |
  54. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | void | :ref:`area_remove_shape<class_PhysicsServer3D_method_area_remove_shape>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |
  56. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | void | :ref:`area_set_area_monitor_callback<class_PhysicsServer3D_method_area_set_area_monitor_callback>` **(** :ref:`RID<class_RID>` area, :ref:`Callable<class_Callable>` callback **)** |
  58. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | void | :ref:`area_set_collision_layer<class_PhysicsServer3D_method_area_set_collision_layer>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` layer **)** |
  60. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | void | :ref:`area_set_collision_mask<class_PhysicsServer3D_method_area_set_collision_mask>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` mask **)** |
  62. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | void | :ref:`area_set_monitor_callback<class_PhysicsServer3D_method_area_set_monitor_callback>` **(** :ref:`RID<class_RID>` area, :ref:`Callable<class_Callable>` callback **)** |
  64. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | void | :ref:`area_set_monitorable<class_PhysicsServer3D_method_area_set_monitorable>` **(** :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` monitorable **)** |
  66. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | void | :ref:`area_set_param<class_PhysicsServer3D_method_area_set_param>` **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` param, :ref:`Variant<class_Variant>` value **)** |
  68. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | void | :ref:`area_set_ray_pickable<class_PhysicsServer3D_method_area_set_ray_pickable>` **(** :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` enable **)** |
  70. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | void | :ref:`area_set_shape<class_PhysicsServer3D_method_area_set_shape>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)** |
  72. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | void | :ref:`area_set_shape_disabled<class_PhysicsServer3D_method_area_set_shape_disabled>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)** |
  74. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | void | :ref:`area_set_shape_transform<class_PhysicsServer3D_method_area_set_shape_transform>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`Transform3D<class_Transform3D>` transform **)** |
  76. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | void | :ref:`area_set_space<class_PhysicsServer3D_method_area_set_space>` **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` space **)** |
  78. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | void | :ref:`area_set_transform<class_PhysicsServer3D_method_area_set_transform>` **(** :ref:`RID<class_RID>` area, :ref:`Transform3D<class_Transform3D>` transform **)** |
  80. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | void | :ref:`body_add_collision_exception<class_PhysicsServer3D_method_body_add_collision_exception>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)** |
  82. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | void | :ref:`body_add_constant_central_force<class_PhysicsServer3D_method_body_add_constant_central_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` force **)** |
  84. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | void | :ref:`body_add_constant_force<class_PhysicsServer3D_method_body_add_constant_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` force, :ref:`Vector3<class_Vector3>` position=Vector3(0, 0, 0) **)** |
  86. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | void | :ref:`body_add_constant_torque<class_PhysicsServer3D_method_body_add_constant_torque>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` torque **)** |
  88. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | void | :ref:`body_add_shape<class_PhysicsServer3D_method_body_add_shape>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` shape, :ref:`Transform3D<class_Transform3D>` transform=Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), :ref:`bool<class_bool>` disabled=false **)** |
  90. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | void | :ref:`body_apply_central_force<class_PhysicsServer3D_method_body_apply_central_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` force **)** |
  92. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | void | :ref:`body_apply_central_impulse<class_PhysicsServer3D_method_body_apply_central_impulse>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` impulse **)** |
  94. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | void | :ref:`body_apply_force<class_PhysicsServer3D_method_body_apply_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` force, :ref:`Vector3<class_Vector3>` position=Vector3(0, 0, 0) **)** |
  96. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | void | :ref:`body_apply_impulse<class_PhysicsServer3D_method_body_apply_impulse>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` impulse, :ref:`Vector3<class_Vector3>` position=Vector3(0, 0, 0) **)** |
  98. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | void | :ref:`body_apply_torque<class_PhysicsServer3D_method_body_apply_torque>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` torque **)** |
  100. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | void | :ref:`body_apply_torque_impulse<class_PhysicsServer3D_method_body_apply_torque_impulse>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` impulse **)** |
  102. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | void | :ref:`body_attach_object_instance_id<class_PhysicsServer3D_method_body_attach_object_instance_id>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)** |
  104. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | void | :ref:`body_clear_shapes<class_PhysicsServer3D_method_body_clear_shapes>` **(** :ref:`RID<class_RID>` body **)** |
  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>` **(** :ref:`RID<class_RID>` body **)** |const| |
  110. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | :ref:`int<class_int>` | :ref:`body_get_collision_mask<class_PhysicsServer3D_method_body_get_collision_mask>` **(** :ref:`RID<class_RID>` body **)** |const| |
  112. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | :ref:`float<class_float>` | :ref:`body_get_collision_priority<class_PhysicsServer3D_method_body_get_collision_priority>` **(** :ref:`RID<class_RID>` body **)** |const| |
  114. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | :ref:`Vector3<class_Vector3>` | :ref:`body_get_constant_force<class_PhysicsServer3D_method_body_get_constant_force>` **(** :ref:`RID<class_RID>` body **)** |const| |
  116. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | :ref:`Vector3<class_Vector3>` | :ref:`body_get_constant_torque<class_PhysicsServer3D_method_body_get_constant_torque>` **(** :ref:`RID<class_RID>` body **)** |const| |
  118. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>` | :ref:`body_get_direct_state<class_PhysicsServer3D_method_body_get_direct_state>` **(** :ref:`RID<class_RID>` body **)** |
  120. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | :ref:`int<class_int>` | :ref:`body_get_max_contacts_reported<class_PhysicsServer3D_method_body_get_max_contacts_reported>` **(** :ref:`RID<class_RID>` body **)** |const| |
  122. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` | :ref:`body_get_mode<class_PhysicsServer3D_method_body_get_mode>` **(** :ref:`RID<class_RID>` body **)** |const| |
  124. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | :ref:`int<class_int>` | :ref:`body_get_object_instance_id<class_PhysicsServer3D_method_body_get_object_instance_id>` **(** :ref:`RID<class_RID>` body **)** |const| |
  126. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | :ref:`Variant<class_Variant>` | :ref:`body_get_param<class_PhysicsServer3D_method_body_get_param>` **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` param **)** |const| |
  128. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | :ref:`RID<class_RID>` | :ref:`body_get_shape<class_PhysicsServer3D_method_body_get_shape>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |const| |
  130. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | :ref:`int<class_int>` | :ref:`body_get_shape_count<class_PhysicsServer3D_method_body_get_shape_count>` **(** :ref:`RID<class_RID>` body **)** |const| |
  132. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | :ref:`Transform3D<class_Transform3D>` | :ref:`body_get_shape_transform<class_PhysicsServer3D_method_body_get_shape_transform>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |const| |
  134. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | :ref:`RID<class_RID>` | :ref:`body_get_space<class_PhysicsServer3D_method_body_get_space>` **(** :ref:`RID<class_RID>` body **)** |const| |
  136. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | :ref:`Variant<class_Variant>` | :ref:`body_get_state<class_PhysicsServer3D_method_body_get_state>` **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_PhysicsServer3D_BodyState>` state **)** |const| |
  138. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | :ref:`bool<class_bool>` | :ref:`body_is_axis_locked<class_PhysicsServer3D_method_body_is_axis_locked>` **(** :ref:`RID<class_RID>` body, :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` axis **)** |const| |
  140. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | :ref:`bool<class_bool>` | :ref:`body_is_continuous_collision_detection_enabled<class_PhysicsServer3D_method_body_is_continuous_collision_detection_enabled>` **(** :ref:`RID<class_RID>` body **)** |const| |
  142. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | :ref:`bool<class_bool>` | :ref:`body_is_omitting_force_integration<class_PhysicsServer3D_method_body_is_omitting_force_integration>` **(** :ref:`RID<class_RID>` body **)** |const| |
  144. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | void | :ref:`body_remove_collision_exception<class_PhysicsServer3D_method_body_remove_collision_exception>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)** |
  146. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | void | :ref:`body_remove_shape<class_PhysicsServer3D_method_body_remove_shape>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |
  148. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | void | :ref:`body_reset_mass_properties<class_PhysicsServer3D_method_body_reset_mass_properties>` **(** :ref:`RID<class_RID>` body **)** |
  150. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | void | :ref:`body_set_axis_lock<class_PhysicsServer3D_method_body_set_axis_lock>` **(** :ref:`RID<class_RID>` body, :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` axis, :ref:`bool<class_bool>` lock **)** |
  152. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | void | :ref:`body_set_axis_velocity<class_PhysicsServer3D_method_body_set_axis_velocity>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` axis_velocity **)** |
  154. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | void | :ref:`body_set_collision_layer<class_PhysicsServer3D_method_body_set_collision_layer>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` layer **)** |
  156. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | void | :ref:`body_set_collision_mask<class_PhysicsServer3D_method_body_set_collision_mask>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` mask **)** |
  158. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | void | :ref:`body_set_collision_priority<class_PhysicsServer3D_method_body_set_collision_priority>` **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` priority **)** |
  160. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | void | :ref:`body_set_constant_force<class_PhysicsServer3D_method_body_set_constant_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` force **)** |
  162. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | void | :ref:`body_set_constant_torque<class_PhysicsServer3D_method_body_set_constant_torque>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` torque **)** |
  164. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. | void | :ref:`body_set_enable_continuous_collision_detection<class_PhysicsServer3D_method_body_set_enable_continuous_collision_detection>` **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)** |
  166. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  167. | void | :ref:`body_set_force_integration_callback<class_PhysicsServer3D_method_body_set_force_integration_callback>` **(** :ref:`RID<class_RID>` body, :ref:`Callable<class_Callable>` callable, :ref:`Variant<class_Variant>` userdata=null **)** |
  168. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  169. | void | :ref:`body_set_max_contacts_reported<class_PhysicsServer3D_method_body_set_max_contacts_reported>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` amount **)** |
  170. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  171. | void | :ref:`body_set_mode<class_PhysicsServer3D_method_body_set_mode>` **(** :ref:`RID<class_RID>` body, :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` mode **)** |
  172. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  173. | void | :ref:`body_set_omit_force_integration<class_PhysicsServer3D_method_body_set_omit_force_integration>` **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)** |
  174. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  175. | void | :ref:`body_set_param<class_PhysicsServer3D_method_body_set_param>` **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` param, :ref:`Variant<class_Variant>` value **)** |
  176. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  177. | void | :ref:`body_set_ray_pickable<class_PhysicsServer3D_method_body_set_ray_pickable>` **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)** |
  178. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  179. | void | :ref:`body_set_shape<class_PhysicsServer3D_method_body_set_shape>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)** |
  180. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  181. | void | :ref:`body_set_shape_disabled<class_PhysicsServer3D_method_body_set_shape_disabled>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)** |
  182. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | void | :ref:`body_set_shape_transform<class_PhysicsServer3D_method_body_set_shape_transform>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`Transform3D<class_Transform3D>` transform **)** |
  184. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | void | :ref:`body_set_space<class_PhysicsServer3D_method_body_set_space>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` space **)** |
  186. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | void | :ref:`body_set_state<class_PhysicsServer3D_method_body_set_state>` **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_PhysicsServer3D_BodyState>` state, :ref:`Variant<class_Variant>` value **)** |
  188. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | :ref:`bool<class_bool>` | :ref:`body_test_motion<class_PhysicsServer3D_method_body_test_motion>` **(** :ref:`RID<class_RID>` body, :ref:`PhysicsTestMotionParameters3D<class_PhysicsTestMotionParameters3D>` parameters, :ref:`PhysicsTestMotionResult3D<class_PhysicsTestMotionResult3D>` result=null **)** |
  190. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | :ref:`RID<class_RID>` | :ref:`box_shape_create<class_PhysicsServer3D_method_box_shape_create>` **(** **)** |
  192. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | :ref:`RID<class_RID>` | :ref:`capsule_shape_create<class_PhysicsServer3D_method_capsule_shape_create>` **(** **)** |
  194. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | :ref:`RID<class_RID>` | :ref:`concave_polygon_shape_create<class_PhysicsServer3D_method_concave_polygon_shape_create>` **(** **)** |
  196. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | :ref:`float<class_float>` | :ref:`cone_twist_joint_get_param<class_PhysicsServer3D_method_cone_twist_joint_get_param>` **(** :ref:`RID<class_RID>` joint, :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` param **)** |const| |
  198. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | void | :ref:`cone_twist_joint_set_param<class_PhysicsServer3D_method_cone_twist_joint_set_param>` **(** :ref:`RID<class_RID>` joint, :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` param, :ref:`float<class_float>` value **)** |
  200. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | :ref:`RID<class_RID>` | :ref:`convex_polygon_shape_create<class_PhysicsServer3D_method_convex_polygon_shape_create>` **(** **)** |
  202. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | :ref:`RID<class_RID>` | :ref:`custom_shape_create<class_PhysicsServer3D_method_custom_shape_create>` **(** **)** |
  204. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | :ref:`RID<class_RID>` | :ref:`cylinder_shape_create<class_PhysicsServer3D_method_cylinder_shape_create>` **(** **)** |
  206. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | void | :ref:`free_rid<class_PhysicsServer3D_method_free_rid>` **(** :ref:`RID<class_RID>` rid **)** |
  208. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | :ref:`bool<class_bool>` | :ref:`generic_6dof_joint_get_flag<class_PhysicsServer3D_method_generic_6dof_joint_get_flag>` **(** :ref:`RID<class_RID>` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` flag **)** |const| |
  210. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | :ref:`float<class_float>` | :ref:`generic_6dof_joint_get_param<class_PhysicsServer3D_method_generic_6dof_joint_get_param>` **(** :ref:`RID<class_RID>` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` param **)** |const| |
  212. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. | void | :ref:`generic_6dof_joint_set_flag<class_PhysicsServer3D_method_generic_6dof_joint_set_flag>` **(** :ref:`RID<class_RID>` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` flag, :ref:`bool<class_bool>` enable **)** |
  214. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  215. | void | :ref:`generic_6dof_joint_set_param<class_PhysicsServer3D_method_generic_6dof_joint_set_param>` **(** :ref:`RID<class_RID>` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` param, :ref:`float<class_float>` value **)** |
  216. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  217. | :ref:`int<class_int>` | :ref:`get_process_info<class_PhysicsServer3D_method_get_process_info>` **(** :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>` process_info **)** |
  218. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  219. | :ref:`RID<class_RID>` | :ref:`heightmap_shape_create<class_PhysicsServer3D_method_heightmap_shape_create>` **(** **)** |
  220. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  221. | :ref:`bool<class_bool>` | :ref:`hinge_joint_get_flag<class_PhysicsServer3D_method_hinge_joint_get_flag>` **(** :ref:`RID<class_RID>` joint, :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` flag **)** |const| |
  222. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  223. | :ref:`float<class_float>` | :ref:`hinge_joint_get_param<class_PhysicsServer3D_method_hinge_joint_get_param>` **(** :ref:`RID<class_RID>` joint, :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` param **)** |const| |
  224. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  225. | void | :ref:`hinge_joint_set_flag<class_PhysicsServer3D_method_hinge_joint_set_flag>` **(** :ref:`RID<class_RID>` joint, :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` flag, :ref:`bool<class_bool>` enabled **)** |
  226. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  227. | void | :ref:`hinge_joint_set_param<class_PhysicsServer3D_method_hinge_joint_set_param>` **(** :ref:`RID<class_RID>` joint, :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` param, :ref:`float<class_float>` value **)** |
  228. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  229. | void | :ref:`joint_clear<class_PhysicsServer3D_method_joint_clear>` **(** :ref:`RID<class_RID>` joint **)** |
  230. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  231. | :ref:`RID<class_RID>` | :ref:`joint_create<class_PhysicsServer3D_method_joint_create>` **(** **)** |
  232. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  233. | void | :ref:`joint_disable_collisions_between_bodies<class_PhysicsServer3D_method_joint_disable_collisions_between_bodies>` **(** :ref:`RID<class_RID>` joint, :ref:`bool<class_bool>` disable **)** |
  234. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  235. | :ref:`int<class_int>` | :ref:`joint_get_solver_priority<class_PhysicsServer3D_method_joint_get_solver_priority>` **(** :ref:`RID<class_RID>` joint **)** |const| |
  236. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  237. | :ref:`JointType<enum_PhysicsServer3D_JointType>` | :ref:`joint_get_type<class_PhysicsServer3D_method_joint_get_type>` **(** :ref:`RID<class_RID>` joint **)** |const| |
  238. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  239. | :ref:`bool<class_bool>` | :ref:`joint_is_disabled_collisions_between_bodies<class_PhysicsServer3D_method_joint_is_disabled_collisions_between_bodies>` **(** :ref:`RID<class_RID>` joint **)** |const| |
  240. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  241. | void | :ref:`joint_make_cone_twist<class_PhysicsServer3D_method_joint_make_cone_twist>` **(** :ref:`RID<class_RID>` joint, :ref:`RID<class_RID>` body_A, :ref:`Transform3D<class_Transform3D>` local_ref_A, :ref:`RID<class_RID>` body_B, :ref:`Transform3D<class_Transform3D>` local_ref_B **)** |
  242. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  243. | void | :ref:`joint_make_generic_6dof<class_PhysicsServer3D_method_joint_make_generic_6dof>` **(** :ref:`RID<class_RID>` joint, :ref:`RID<class_RID>` body_A, :ref:`Transform3D<class_Transform3D>` local_ref_A, :ref:`RID<class_RID>` body_B, :ref:`Transform3D<class_Transform3D>` local_ref_B **)** |
  244. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  245. | void | :ref:`joint_make_hinge<class_PhysicsServer3D_method_joint_make_hinge>` **(** :ref:`RID<class_RID>` joint, :ref:`RID<class_RID>` body_A, :ref:`Transform3D<class_Transform3D>` hinge_A, :ref:`RID<class_RID>` body_B, :ref:`Transform3D<class_Transform3D>` hinge_B **)** |
  246. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  247. | void | :ref:`joint_make_pin<class_PhysicsServer3D_method_joint_make_pin>` **(** :ref:`RID<class_RID>` joint, :ref:`RID<class_RID>` body_A, :ref:`Vector3<class_Vector3>` local_A, :ref:`RID<class_RID>` body_B, :ref:`Vector3<class_Vector3>` local_B **)** |
  248. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  249. | void | :ref:`joint_make_slider<class_PhysicsServer3D_method_joint_make_slider>` **(** :ref:`RID<class_RID>` joint, :ref:`RID<class_RID>` body_A, :ref:`Transform3D<class_Transform3D>` local_ref_A, :ref:`RID<class_RID>` body_B, :ref:`Transform3D<class_Transform3D>` local_ref_B **)** |
  250. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  251. | void | :ref:`joint_set_solver_priority<class_PhysicsServer3D_method_joint_set_solver_priority>` **(** :ref:`RID<class_RID>` joint, :ref:`int<class_int>` priority **)** |
  252. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  253. | :ref:`Vector3<class_Vector3>` | :ref:`pin_joint_get_local_a<class_PhysicsServer3D_method_pin_joint_get_local_a>` **(** :ref:`RID<class_RID>` joint **)** |const| |
  254. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  255. | :ref:`Vector3<class_Vector3>` | :ref:`pin_joint_get_local_b<class_PhysicsServer3D_method_pin_joint_get_local_b>` **(** :ref:`RID<class_RID>` joint **)** |const| |
  256. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  257. | :ref:`float<class_float>` | :ref:`pin_joint_get_param<class_PhysicsServer3D_method_pin_joint_get_param>` **(** :ref:`RID<class_RID>` joint, :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` param **)** |const| |
  258. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  259. | void | :ref:`pin_joint_set_local_a<class_PhysicsServer3D_method_pin_joint_set_local_a>` **(** :ref:`RID<class_RID>` joint, :ref:`Vector3<class_Vector3>` local_A **)** |
  260. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  261. | void | :ref:`pin_joint_set_local_b<class_PhysicsServer3D_method_pin_joint_set_local_b>` **(** :ref:`RID<class_RID>` joint, :ref:`Vector3<class_Vector3>` local_B **)** |
  262. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  263. | void | :ref:`pin_joint_set_param<class_PhysicsServer3D_method_pin_joint_set_param>` **(** :ref:`RID<class_RID>` joint, :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` param, :ref:`float<class_float>` value **)** |
  264. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  265. | :ref:`RID<class_RID>` | :ref:`separation_ray_shape_create<class_PhysicsServer3D_method_separation_ray_shape_create>` **(** **)** |
  266. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  267. | void | :ref:`set_active<class_PhysicsServer3D_method_set_active>` **(** :ref:`bool<class_bool>` active **)** |
  268. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  269. | :ref:`Variant<class_Variant>` | :ref:`shape_get_data<class_PhysicsServer3D_method_shape_get_data>` **(** :ref:`RID<class_RID>` shape **)** |const| |
  270. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  271. | :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` | :ref:`shape_get_type<class_PhysicsServer3D_method_shape_get_type>` **(** :ref:`RID<class_RID>` shape **)** |const| |
  272. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  273. | void | :ref:`shape_set_data<class_PhysicsServer3D_method_shape_set_data>` **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_Variant>` data **)** |
  274. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  275. | :ref:`float<class_float>` | :ref:`slider_joint_get_param<class_PhysicsServer3D_method_slider_joint_get_param>` **(** :ref:`RID<class_RID>` joint, :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` param **)** |const| |
  276. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  277. | void | :ref:`slider_joint_set_param<class_PhysicsServer3D_method_slider_joint_set_param>` **(** :ref:`RID<class_RID>` joint, :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` param, :ref:`float<class_float>` value **)** |
  278. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  279. | :ref:`AABB<class_AABB>` | :ref:`soft_body_get_bounds<class_PhysicsServer3D_method_soft_body_get_bounds>` **(** :ref:`RID<class_RID>` body **)** |const| |
  280. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  281. | :ref:`RID<class_RID>` | :ref:`space_create<class_PhysicsServer3D_method_space_create>` **(** **)** |
  282. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  283. | :ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>` | :ref:`space_get_direct_state<class_PhysicsServer3D_method_space_get_direct_state>` **(** :ref:`RID<class_RID>` space **)** |
  284. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  285. | :ref:`float<class_float>` | :ref:`space_get_param<class_PhysicsServer3D_method_space_get_param>` **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` param **)** |const| |
  286. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  287. | :ref:`bool<class_bool>` | :ref:`space_is_active<class_PhysicsServer3D_method_space_is_active>` **(** :ref:`RID<class_RID>` space **)** |const| |
  288. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  289. | void | :ref:`space_set_active<class_PhysicsServer3D_method_space_set_active>` **(** :ref:`RID<class_RID>` space, :ref:`bool<class_bool>` active **)** |
  290. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  291. | void | :ref:`space_set_param<class_PhysicsServer3D_method_space_set_param>` **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` param, :ref:`float<class_float>` value **)** |
  292. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  293. | :ref:`RID<class_RID>` | :ref:`sphere_shape_create<class_PhysicsServer3D_method_sphere_shape_create>` **(** **)** |
  294. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  295. | :ref:`RID<class_RID>` | :ref:`world_boundary_shape_create<class_PhysicsServer3D_method_world_boundary_shape_create>` **(** **)** |
  296. +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  297. .. rst-class:: classref-section-separator
  298. ----
  299. .. rst-class:: classref-descriptions-group
  300. Enumerations
  301. ------------
  302. .. _enum_PhysicsServer3D_JointType:
  303. .. rst-class:: classref-enumeration
  304. enum **JointType**:
  305. .. _class_PhysicsServer3D_constant_JOINT_TYPE_PIN:
  306. .. rst-class:: classref-enumeration-constant
  307. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_PIN** = ``0``
  308. The :ref:`Joint3D<class_Joint3D>` is a :ref:`PinJoint3D<class_PinJoint3D>`.
  309. .. _class_PhysicsServer3D_constant_JOINT_TYPE_HINGE:
  310. .. rst-class:: classref-enumeration-constant
  311. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_HINGE** = ``1``
  312. The :ref:`Joint3D<class_Joint3D>` is a :ref:`HingeJoint3D<class_HingeJoint3D>`.
  313. .. _class_PhysicsServer3D_constant_JOINT_TYPE_SLIDER:
  314. .. rst-class:: classref-enumeration-constant
  315. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_SLIDER** = ``2``
  316. The :ref:`Joint3D<class_Joint3D>` is a :ref:`SliderJoint3D<class_SliderJoint3D>`.
  317. .. _class_PhysicsServer3D_constant_JOINT_TYPE_CONE_TWIST:
  318. .. rst-class:: classref-enumeration-constant
  319. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_CONE_TWIST** = ``3``
  320. The :ref:`Joint3D<class_Joint3D>` is a :ref:`ConeTwistJoint3D<class_ConeTwistJoint3D>`.
  321. .. _class_PhysicsServer3D_constant_JOINT_TYPE_6DOF:
  322. .. rst-class:: classref-enumeration-constant
  323. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_6DOF** = ``4``
  324. The :ref:`Joint3D<class_Joint3D>` is a :ref:`Generic6DOFJoint3D<class_Generic6DOFJoint3D>`.
  325. .. _class_PhysicsServer3D_constant_JOINT_TYPE_MAX:
  326. .. rst-class:: classref-enumeration-constant
  327. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_MAX** = ``5``
  328. Represents the size of the :ref:`JointType<enum_PhysicsServer3D_JointType>` enum.
  329. .. rst-class:: classref-item-separator
  330. ----
  331. .. _enum_PhysicsServer3D_PinJointParam:
  332. .. rst-class:: classref-enumeration
  333. enum **PinJointParam**:
  334. .. _class_PhysicsServer3D_constant_PIN_JOINT_BIAS:
  335. .. rst-class:: classref-enumeration-constant
  336. :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` **PIN_JOINT_BIAS** = ``0``
  337. The strength with which the pinned objects try to stay in positional relation to each other.
  338. The higher, the stronger.
  339. .. _class_PhysicsServer3D_constant_PIN_JOINT_DAMPING:
  340. .. rst-class:: classref-enumeration-constant
  341. :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` **PIN_JOINT_DAMPING** = ``1``
  342. The strength with which the pinned objects try to stay in velocity relation to each other.
  343. The higher, the stronger.
  344. .. _class_PhysicsServer3D_constant_PIN_JOINT_IMPULSE_CLAMP:
  345. .. rst-class:: classref-enumeration-constant
  346. :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` **PIN_JOINT_IMPULSE_CLAMP** = ``2``
  347. If above 0, this value is the maximum value for an impulse that this Joint3D puts on its ends.
  348. .. rst-class:: classref-item-separator
  349. ----
  350. .. _enum_PhysicsServer3D_HingeJointParam:
  351. .. rst-class:: classref-enumeration
  352. enum **HingeJointParam**:
  353. .. _class_PhysicsServer3D_constant_HINGE_JOINT_BIAS:
  354. .. rst-class:: classref-enumeration-constant
  355. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_BIAS** = ``0``
  356. The speed with which the two bodies get pulled together when they move in different directions.
  357. .. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_UPPER:
  358. .. rst-class:: classref-enumeration-constant
  359. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_LIMIT_UPPER** = ``1``
  360. The maximum rotation across the Hinge.
  361. .. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_LOWER:
  362. .. rst-class:: classref-enumeration-constant
  363. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_LIMIT_LOWER** = ``2``
  364. The minimum rotation across the Hinge.
  365. .. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_BIAS:
  366. .. rst-class:: classref-enumeration-constant
  367. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_LIMIT_BIAS** = ``3``
  368. The speed with which the rotation across the axis perpendicular to the hinge gets corrected.
  369. .. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_SOFTNESS:
  370. .. rst-class:: classref-enumeration-constant
  371. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_LIMIT_SOFTNESS** = ``4``
  372. .. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_RELAXATION:
  373. .. rst-class:: classref-enumeration-constant
  374. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_LIMIT_RELAXATION** = ``5``
  375. The lower this value, the more the rotation gets slowed down.
  376. .. _class_PhysicsServer3D_constant_HINGE_JOINT_MOTOR_TARGET_VELOCITY:
  377. .. rst-class:: classref-enumeration-constant
  378. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_MOTOR_TARGET_VELOCITY** = ``6``
  379. Target speed for the motor.
  380. .. _class_PhysicsServer3D_constant_HINGE_JOINT_MOTOR_MAX_IMPULSE:
  381. .. rst-class:: classref-enumeration-constant
  382. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_MOTOR_MAX_IMPULSE** = ``7``
  383. Maximum acceleration for the motor.
  384. .. rst-class:: classref-item-separator
  385. ----
  386. .. _enum_PhysicsServer3D_HingeJointFlag:
  387. .. rst-class:: classref-enumeration
  388. enum **HingeJointFlag**:
  389. .. _class_PhysicsServer3D_constant_HINGE_JOINT_FLAG_USE_LIMIT:
  390. .. rst-class:: classref-enumeration-constant
  391. :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` **HINGE_JOINT_FLAG_USE_LIMIT** = ``0``
  392. If ``true``, the Hinge has a maximum and a minimum rotation.
  393. .. _class_PhysicsServer3D_constant_HINGE_JOINT_FLAG_ENABLE_MOTOR:
  394. .. rst-class:: classref-enumeration-constant
  395. :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` **HINGE_JOINT_FLAG_ENABLE_MOTOR** = ``1``
  396. If ``true``, a motor turns the Hinge.
  397. .. rst-class:: classref-item-separator
  398. ----
  399. .. _enum_PhysicsServer3D_SliderJointParam:
  400. .. rst-class:: classref-enumeration
  401. enum **SliderJointParam**:
  402. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_UPPER:
  403. .. rst-class:: classref-enumeration-constant
  404. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_LIMIT_UPPER** = ``0``
  405. The maximum difference between the pivot points on their X axis before damping happens.
  406. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_LOWER:
  407. .. rst-class:: classref-enumeration-constant
  408. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_LIMIT_LOWER** = ``1``
  409. The minimum difference between the pivot points on their X axis before damping happens.
  410. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS:
  411. .. rst-class:: classref-enumeration-constant
  412. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS** = ``2``
  413. A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.
  414. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION:
  415. .. rst-class:: classref-enumeration-constant
  416. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION** = ``3``
  417. The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost.
  418. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_DAMPING:
  419. .. rst-class:: classref-enumeration-constant
  420. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_LIMIT_DAMPING** = ``4``
  421. The amount of damping once the slider limits are surpassed.
  422. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_MOTION_SOFTNESS:
  423. .. rst-class:: classref-enumeration-constant
  424. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_MOTION_SOFTNESS** = ``5``
  425. 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.
  426. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_MOTION_RESTITUTION:
  427. .. rst-class:: classref-enumeration-constant
  428. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_MOTION_RESTITUTION** = ``6``
  429. The amount of restitution inside the slider limits.
  430. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_MOTION_DAMPING:
  431. .. rst-class:: classref-enumeration-constant
  432. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_MOTION_DAMPING** = ``7``
  433. The amount of damping inside the slider limits.
  434. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS:
  435. .. rst-class:: classref-enumeration-constant
  436. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS** = ``8``
  437. A factor applied to the movement across axes orthogonal to the slider.
  438. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION:
  439. .. rst-class:: classref-enumeration-constant
  440. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION** = ``9``
  441. The amount of restitution when movement is across axes orthogonal to the slider.
  442. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING:
  443. .. rst-class:: classref-enumeration-constant
  444. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING** = ``10``
  445. The amount of damping when movement is across axes orthogonal to the slider.
  446. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_UPPER:
  447. .. rst-class:: classref-enumeration-constant
  448. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_LIMIT_UPPER** = ``11``
  449. The upper limit of rotation in the slider.
  450. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_LOWER:
  451. .. rst-class:: classref-enumeration-constant
  452. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_LIMIT_LOWER** = ``12``
  453. The lower limit of rotation in the slider.
  454. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS:
  455. .. rst-class:: classref-enumeration-constant
  456. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS** = ``13``
  457. A factor applied to the all rotation once the limit is surpassed.
  458. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION:
  459. .. rst-class:: classref-enumeration-constant
  460. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION** = ``14``
  461. The amount of restitution of the rotation when the limit is surpassed.
  462. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_DAMPING:
  463. .. rst-class:: classref-enumeration-constant
  464. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_LIMIT_DAMPING** = ``15``
  465. The amount of damping of the rotation when the limit is surpassed.
  466. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS:
  467. .. rst-class:: classref-enumeration-constant
  468. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS** = ``16``
  469. A factor that gets applied to the all rotation in the limits.
  470. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION:
  471. .. rst-class:: classref-enumeration-constant
  472. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION** = ``17``
  473. The amount of restitution of the rotation in the limits.
  474. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_MOTION_DAMPING:
  475. .. rst-class:: classref-enumeration-constant
  476. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_MOTION_DAMPING** = ``18``
  477. The amount of damping of the rotation in the limits.
  478. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS:
  479. .. rst-class:: classref-enumeration-constant
  480. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS** = ``19``
  481. A factor that gets applied to the all rotation across axes orthogonal to the slider.
  482. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION:
  483. .. rst-class:: classref-enumeration-constant
  484. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION** = ``20``
  485. The amount of restitution of the rotation across axes orthogonal to the slider.
  486. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING:
  487. .. rst-class:: classref-enumeration-constant
  488. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING** = ``21``
  489. The amount of damping of the rotation across axes orthogonal to the slider.
  490. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_MAX:
  491. .. rst-class:: classref-enumeration-constant
  492. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_MAX** = ``22``
  493. Represents the size of the :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` enum.
  494. .. rst-class:: classref-item-separator
  495. ----
  496. .. _enum_PhysicsServer3D_ConeTwistJointParam:
  497. .. rst-class:: classref-enumeration
  498. enum **ConeTwistJointParam**:
  499. .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_SWING_SPAN:
  500. .. rst-class:: classref-enumeration-constant
  501. :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` **CONE_TWIST_JOINT_SWING_SPAN** = ``0``
  502. Swing is rotation from side to side, around the axis perpendicular to the twist axis.
  503. The swing span defines, how much rotation will not get corrected along the swing axis.
  504. Could be defined as looseness in the :ref:`ConeTwistJoint3D<class_ConeTwistJoint3D>`.
  505. If below 0.05, this behavior is locked.
  506. .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_TWIST_SPAN:
  507. .. rst-class:: classref-enumeration-constant
  508. :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` **CONE_TWIST_JOINT_TWIST_SPAN** = ``1``
  509. Twist is the rotation around the twist axis, this value defined how far the joint can twist.
  510. Twist is locked if below 0.05.
  511. .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_BIAS:
  512. .. rst-class:: classref-enumeration-constant
  513. :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` **CONE_TWIST_JOINT_BIAS** = ``2``
  514. The speed with which the swing or twist will take place.
  515. The higher, the faster.
  516. .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_SOFTNESS:
  517. .. rst-class:: classref-enumeration-constant
  518. :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` **CONE_TWIST_JOINT_SOFTNESS** = ``3``
  519. The ease with which the Joint3D twists, if it's too low, it takes more force to twist the joint.
  520. .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_RELAXATION:
  521. .. rst-class:: classref-enumeration-constant
  522. :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` **CONE_TWIST_JOINT_RELAXATION** = ``4``
  523. Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
  524. .. rst-class:: classref-item-separator
  525. ----
  526. .. _enum_PhysicsServer3D_G6DOFJointAxisParam:
  527. .. rst-class:: classref-enumeration
  528. enum **G6DOFJointAxisParam**:
  529. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_LOWER_LIMIT:
  530. .. rst-class:: classref-enumeration-constant
  531. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_LOWER_LIMIT** = ``0``
  532. The minimum difference between the pivot points' axes.
  533. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_UPPER_LIMIT:
  534. .. rst-class:: classref-enumeration-constant
  535. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_UPPER_LIMIT** = ``1``
  536. The maximum difference between the pivot points' axes.
  537. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS:
  538. .. rst-class:: classref-enumeration-constant
  539. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS** = ``2``
  540. A factor that gets applied to the movement across the axes. The lower, the slower the movement.
  541. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_RESTITUTION:
  542. .. rst-class:: classref-enumeration-constant
  543. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_RESTITUTION** = ``3``
  544. The amount of restitution on the axes movement. The lower, the more velocity-energy gets lost.
  545. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_DAMPING:
  546. .. rst-class:: classref-enumeration-constant
  547. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_DAMPING** = ``4``
  548. The amount of damping that happens at the linear motion across the axes.
  549. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_MOTOR_TARGET_VELOCITY:
  550. .. rst-class:: classref-enumeration-constant
  551. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_MOTOR_TARGET_VELOCITY** = ``5``
  552. The velocity that the joint's linear motor will attempt to reach.
  553. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_MOTOR_FORCE_LIMIT:
  554. .. rst-class:: classref-enumeration-constant
  555. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_MOTOR_FORCE_LIMIT** = ``6``
  556. The maximum force that the linear motor can apply while trying to reach the target velocity.
  557. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_LOWER_LIMIT:
  558. .. rst-class:: classref-enumeration-constant
  559. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_LOWER_LIMIT** = ``10``
  560. The minimum rotation in negative direction to break loose and rotate around the axes.
  561. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_UPPER_LIMIT:
  562. .. rst-class:: classref-enumeration-constant
  563. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_UPPER_LIMIT** = ``11``
  564. The minimum rotation in positive direction to break loose and rotate around the axes.
  565. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS:
  566. .. rst-class:: classref-enumeration-constant
  567. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS** = ``12``
  568. A factor that gets multiplied onto all rotations across the axes.
  569. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_DAMPING:
  570. .. rst-class:: classref-enumeration-constant
  571. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_DAMPING** = ``13``
  572. The amount of rotational damping across the axes. The lower, the more damping occurs.
  573. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_RESTITUTION:
  574. .. rst-class:: classref-enumeration-constant
  575. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_RESTITUTION** = ``14``
  576. The amount of rotational restitution across the axes. The lower, the more restitution occurs.
  577. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_FORCE_LIMIT:
  578. .. rst-class:: classref-enumeration-constant
  579. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_FORCE_LIMIT** = ``15``
  580. The maximum amount of force that can occur, when rotating around the axes.
  581. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_ERP:
  582. .. rst-class:: classref-enumeration-constant
  583. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_ERP** = ``16``
  584. 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.
  585. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY:
  586. .. rst-class:: classref-enumeration-constant
  587. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY** = ``17``
  588. Target speed for the motor at the axes.
  589. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT:
  590. .. rst-class:: classref-enumeration-constant
  591. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT** = ``18``
  592. Maximum acceleration for the motor at the axes.
  593. .. rst-class:: classref-item-separator
  594. ----
  595. .. _enum_PhysicsServer3D_G6DOFJointAxisFlag:
  596. .. rst-class:: classref-enumeration
  597. enum **G6DOFJointAxisFlag**:
  598. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT:
  599. .. rst-class:: classref-enumeration-constant
  600. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT** = ``0``
  601. If set, linear motion is possible within the given limits.
  602. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT:
  603. .. rst-class:: classref-enumeration-constant
  604. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT** = ``1``
  605. If set, rotational motion is possible.
  606. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_MOTOR:
  607. .. rst-class:: classref-enumeration-constant
  608. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_MOTOR** = ``4``
  609. If set, there is a rotational motor across these axes.
  610. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR:
  611. .. rst-class:: classref-enumeration-constant
  612. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR** = ``5``
  613. If set, there is a linear motor on this axis that targets a specific velocity.
  614. .. rst-class:: classref-item-separator
  615. ----
  616. .. _enum_PhysicsServer3D_ShapeType:
  617. .. rst-class:: classref-enumeration
  618. enum **ShapeType**:
  619. .. _class_PhysicsServer3D_constant_SHAPE_WORLD_BOUNDARY:
  620. .. rst-class:: classref-enumeration-constant
  621. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_WORLD_BOUNDARY** = ``0``
  622. The :ref:`Shape3D<class_Shape3D>` is a :ref:`WorldBoundaryShape3D<class_WorldBoundaryShape3D>`.
  623. .. _class_PhysicsServer3D_constant_SHAPE_SEPARATION_RAY:
  624. .. rst-class:: classref-enumeration-constant
  625. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_SEPARATION_RAY** = ``1``
  626. The :ref:`Shape3D<class_Shape3D>` is a :ref:`SeparationRayShape3D<class_SeparationRayShape3D>`.
  627. .. _class_PhysicsServer3D_constant_SHAPE_SPHERE:
  628. .. rst-class:: classref-enumeration-constant
  629. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_SPHERE** = ``2``
  630. The :ref:`Shape3D<class_Shape3D>` is a :ref:`SphereShape3D<class_SphereShape3D>`.
  631. .. _class_PhysicsServer3D_constant_SHAPE_BOX:
  632. .. rst-class:: classref-enumeration-constant
  633. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_BOX** = ``3``
  634. The :ref:`Shape3D<class_Shape3D>` is a :ref:`BoxShape3D<class_BoxShape3D>`.
  635. .. _class_PhysicsServer3D_constant_SHAPE_CAPSULE:
  636. .. rst-class:: classref-enumeration-constant
  637. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_CAPSULE** = ``4``
  638. The :ref:`Shape3D<class_Shape3D>` is a :ref:`CapsuleShape3D<class_CapsuleShape3D>`.
  639. .. _class_PhysicsServer3D_constant_SHAPE_CYLINDER:
  640. .. rst-class:: classref-enumeration-constant
  641. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_CYLINDER** = ``5``
  642. The :ref:`Shape3D<class_Shape3D>` is a :ref:`CylinderShape3D<class_CylinderShape3D>`.
  643. .. _class_PhysicsServer3D_constant_SHAPE_CONVEX_POLYGON:
  644. .. rst-class:: classref-enumeration-constant
  645. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_CONVEX_POLYGON** = ``6``
  646. The :ref:`Shape3D<class_Shape3D>` is a :ref:`ConvexPolygonShape3D<class_ConvexPolygonShape3D>`.
  647. .. _class_PhysicsServer3D_constant_SHAPE_CONCAVE_POLYGON:
  648. .. rst-class:: classref-enumeration-constant
  649. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_CONCAVE_POLYGON** = ``7``
  650. The :ref:`Shape3D<class_Shape3D>` is a :ref:`ConcavePolygonShape3D<class_ConcavePolygonShape3D>`.
  651. .. _class_PhysicsServer3D_constant_SHAPE_HEIGHTMAP:
  652. .. rst-class:: classref-enumeration-constant
  653. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_HEIGHTMAP** = ``8``
  654. The :ref:`Shape3D<class_Shape3D>` is a :ref:`HeightMapShape3D<class_HeightMapShape3D>`.
  655. .. _class_PhysicsServer3D_constant_SHAPE_SOFT_BODY:
  656. .. rst-class:: classref-enumeration-constant
  657. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_SOFT_BODY** = ``9``
  658. The :ref:`Shape3D<class_Shape3D>` is used internally for a soft body. Any attempt to create this kind of shape results in an error.
  659. .. _class_PhysicsServer3D_constant_SHAPE_CUSTOM:
  660. .. rst-class:: classref-enumeration-constant
  661. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_CUSTOM** = ``10``
  662. This constant is used internally by the engine. Any attempt to create this kind of shape results in an error.
  663. .. rst-class:: classref-item-separator
  664. ----
  665. .. _enum_PhysicsServer3D_AreaParameter:
  666. .. rst-class:: classref-enumeration
  667. enum **AreaParameter**:
  668. .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_OVERRIDE_MODE:
  669. .. rst-class:: classref-enumeration-constant
  670. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY_OVERRIDE_MODE** = ``0``
  671. Constant to set/get gravity override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` for possible values.
  672. .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY:
  673. .. rst-class:: classref-enumeration-constant
  674. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY** = ``1``
  675. Constant to set/get gravity strength in an area.
  676. .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_VECTOR:
  677. .. rst-class:: classref-enumeration-constant
  678. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY_VECTOR** = ``2``
  679. Constant to set/get gravity vector/center in an area.
  680. .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_IS_POINT:
  681. .. rst-class:: classref-enumeration-constant
  682. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY_IS_POINT** = ``3``
  683. Constant to set/get whether the gravity vector of an area is a direction, or a center point.
  684. .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_POINT_UNIT_DISTANCE:
  685. .. rst-class:: classref-enumeration-constant
  686. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY_POINT_UNIT_DISTANCE** = ``4``
  687. 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.
  688. 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.
  689. .. _class_PhysicsServer3D_constant_AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE:
  690. .. rst-class:: classref-enumeration-constant
  691. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE** = ``5``
  692. Constant to set/get linear damping override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` for possible values.
  693. .. _class_PhysicsServer3D_constant_AREA_PARAM_LINEAR_DAMP:
  694. .. rst-class:: classref-enumeration-constant
  695. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_LINEAR_DAMP** = ``6``
  696. Constant to set/get the linear damping factor of an area.
  697. .. _class_PhysicsServer3D_constant_AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE:
  698. .. rst-class:: classref-enumeration-constant
  699. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE** = ``7``
  700. Constant to set/get angular damping override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` for possible values.
  701. .. _class_PhysicsServer3D_constant_AREA_PARAM_ANGULAR_DAMP:
  702. .. rst-class:: classref-enumeration-constant
  703. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_ANGULAR_DAMP** = ``8``
  704. Constant to set/get the angular damping factor of an area.
  705. .. _class_PhysicsServer3D_constant_AREA_PARAM_PRIORITY:
  706. .. rst-class:: classref-enumeration-constant
  707. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_PRIORITY** = ``9``
  708. Constant to set/get the priority (order of processing) of an area.
  709. .. _class_PhysicsServer3D_constant_AREA_PARAM_WIND_FORCE_MAGNITUDE:
  710. .. rst-class:: classref-enumeration-constant
  711. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_FORCE_MAGNITUDE** = ``10``
  712. Constant to set/get the magnitude of area-specific wind force.
  713. .. _class_PhysicsServer3D_constant_AREA_PARAM_WIND_SOURCE:
  714. .. rst-class:: classref-enumeration-constant
  715. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_SOURCE** = ``11``
  716. Constant to set/get the 3D vector that specifies the origin from which an area-specific wind blows.
  717. .. _class_PhysicsServer3D_constant_AREA_PARAM_WIND_DIRECTION:
  718. .. rst-class:: classref-enumeration-constant
  719. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_DIRECTION** = ``12``
  720. Constant to set/get the 3D vector that specifies the direction in which an area-specific wind blows.
  721. .. _class_PhysicsServer3D_constant_AREA_PARAM_WIND_ATTENUATION_FACTOR:
  722. .. rst-class:: classref-enumeration-constant
  723. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_ATTENUATION_FACTOR** = ``13``
  724. Constant to set/get the exponential rate at which wind force decreases with distance from its origin.
  725. .. rst-class:: classref-item-separator
  726. ----
  727. .. _enum_PhysicsServer3D_AreaSpaceOverrideMode:
  728. .. rst-class:: classref-enumeration
  729. enum **AreaSpaceOverrideMode**:
  730. .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_DISABLED:
  731. .. rst-class:: classref-enumeration-constant
  732. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_DISABLED** = ``0``
  733. This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
  734. .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_COMBINE:
  735. .. rst-class:: classref-enumeration-constant
  736. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_COMBINE** = ``1``
  737. 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.
  738. .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_COMBINE_REPLACE:
  739. .. rst-class:: classref-enumeration-constant
  740. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_COMBINE_REPLACE** = ``2``
  741. 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.
  742. .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_REPLACE:
  743. .. rst-class:: classref-enumeration-constant
  744. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_REPLACE** = ``3``
  745. This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
  746. .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_REPLACE_COMBINE:
  747. .. rst-class:: classref-enumeration-constant
  748. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_REPLACE_COMBINE** = ``4``
  749. This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
  750. .. rst-class:: classref-item-separator
  751. ----
  752. .. _enum_PhysicsServer3D_BodyMode:
  753. .. rst-class:: classref-enumeration
  754. enum **BodyMode**:
  755. .. _class_PhysicsServer3D_constant_BODY_MODE_STATIC:
  756. .. rst-class:: classref-enumeration-constant
  757. :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **BODY_MODE_STATIC** = ``0``
  758. 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.
  759. .. _class_PhysicsServer3D_constant_BODY_MODE_KINEMATIC:
  760. .. rst-class:: classref-enumeration-constant
  761. :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **BODY_MODE_KINEMATIC** = ``1``
  762. Constant for kinematic bodies. In this mode, a body can be only moved by user code and collides with other bodies along its path.
  763. .. _class_PhysicsServer3D_constant_BODY_MODE_RIGID:
  764. .. rst-class:: classref-enumeration-constant
  765. :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **BODY_MODE_RIGID** = ``2``
  766. Constant for rigid bodies. In this mode, a body can be pushed by other bodies and has forces applied.
  767. .. _class_PhysicsServer3D_constant_BODY_MODE_RIGID_LINEAR:
  768. .. rst-class:: classref-enumeration-constant
  769. :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **BODY_MODE_RIGID_LINEAR** = ``3``
  770. Constant for linear rigid bodies. In this mode, a body can not rotate, and only its linear velocity is affected by external forces.
  771. .. rst-class:: classref-item-separator
  772. ----
  773. .. _enum_PhysicsServer3D_BodyParameter:
  774. .. rst-class:: classref-enumeration
  775. enum **BodyParameter**:
  776. .. _class_PhysicsServer3D_constant_BODY_PARAM_BOUNCE:
  777. .. rst-class:: classref-enumeration-constant
  778. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_BOUNCE** = ``0``
  779. Constant to set/get a body's bounce factor.
  780. .. _class_PhysicsServer3D_constant_BODY_PARAM_FRICTION:
  781. .. rst-class:: classref-enumeration-constant
  782. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_FRICTION** = ``1``
  783. Constant to set/get a body's friction.
  784. .. _class_PhysicsServer3D_constant_BODY_PARAM_MASS:
  785. .. rst-class:: classref-enumeration-constant
  786. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_MASS** = ``2``
  787. Constant to set/get a body's mass.
  788. .. _class_PhysicsServer3D_constant_BODY_PARAM_INERTIA:
  789. .. rst-class:: classref-enumeration-constant
  790. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_INERTIA** = ``3``
  791. Constant to set/get a body's inertia.
  792. .. _class_PhysicsServer3D_constant_BODY_PARAM_CENTER_OF_MASS:
  793. .. rst-class:: classref-enumeration-constant
  794. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_CENTER_OF_MASS** = ``4``
  795. Constant to set/get a body's center of mass position in the body's local coordinate system.
  796. .. _class_PhysicsServer3D_constant_BODY_PARAM_GRAVITY_SCALE:
  797. .. rst-class:: classref-enumeration-constant
  798. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_GRAVITY_SCALE** = ``5``
  799. Constant to set/get a body's gravity multiplier.
  800. .. _class_PhysicsServer3D_constant_BODY_PARAM_LINEAR_DAMP_MODE:
  801. .. rst-class:: classref-enumeration-constant
  802. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_LINEAR_DAMP_MODE** = ``6``
  803. Constant to set/get a body's linear damping mode. See :ref:`BodyDampMode<enum_PhysicsServer3D_BodyDampMode>` for possible values.
  804. .. _class_PhysicsServer3D_constant_BODY_PARAM_ANGULAR_DAMP_MODE:
  805. .. rst-class:: classref-enumeration-constant
  806. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_ANGULAR_DAMP_MODE** = ``7``
  807. Constant to set/get a body's angular damping mode. See :ref:`BodyDampMode<enum_PhysicsServer3D_BodyDampMode>` for possible values.
  808. .. _class_PhysicsServer3D_constant_BODY_PARAM_LINEAR_DAMP:
  809. .. rst-class:: classref-enumeration-constant
  810. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_LINEAR_DAMP** = ``8``
  811. Constant to set/get a body's linear damping factor.
  812. .. _class_PhysicsServer3D_constant_BODY_PARAM_ANGULAR_DAMP:
  813. .. rst-class:: classref-enumeration-constant
  814. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_ANGULAR_DAMP** = ``9``
  815. Constant to set/get a body's angular damping factor.
  816. .. _class_PhysicsServer3D_constant_BODY_PARAM_MAX:
  817. .. rst-class:: classref-enumeration-constant
  818. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_MAX** = ``10``
  819. Represents the size of the :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` enum.
  820. .. rst-class:: classref-item-separator
  821. ----
  822. .. _enum_PhysicsServer3D_BodyDampMode:
  823. .. rst-class:: classref-enumeration
  824. enum **BodyDampMode**:
  825. .. _class_PhysicsServer3D_constant_BODY_DAMP_MODE_COMBINE:
  826. .. rst-class:: classref-enumeration-constant
  827. :ref:`BodyDampMode<enum_PhysicsServer3D_BodyDampMode>` **BODY_DAMP_MODE_COMBINE** = ``0``
  828. The body's damping value is added to any value set in areas or the default value.
  829. .. _class_PhysicsServer3D_constant_BODY_DAMP_MODE_REPLACE:
  830. .. rst-class:: classref-enumeration-constant
  831. :ref:`BodyDampMode<enum_PhysicsServer3D_BodyDampMode>` **BODY_DAMP_MODE_REPLACE** = ``1``
  832. The body's damping value replaces any value set in areas or the default value.
  833. .. rst-class:: classref-item-separator
  834. ----
  835. .. _enum_PhysicsServer3D_BodyState:
  836. .. rst-class:: classref-enumeration
  837. enum **BodyState**:
  838. .. _class_PhysicsServer3D_constant_BODY_STATE_TRANSFORM:
  839. .. rst-class:: classref-enumeration-constant
  840. :ref:`BodyState<enum_PhysicsServer3D_BodyState>` **BODY_STATE_TRANSFORM** = ``0``
  841. Constant to set/get the current transform matrix of the body.
  842. .. _class_PhysicsServer3D_constant_BODY_STATE_LINEAR_VELOCITY:
  843. .. rst-class:: classref-enumeration-constant
  844. :ref:`BodyState<enum_PhysicsServer3D_BodyState>` **BODY_STATE_LINEAR_VELOCITY** = ``1``
  845. Constant to set/get the current linear velocity of the body.
  846. .. _class_PhysicsServer3D_constant_BODY_STATE_ANGULAR_VELOCITY:
  847. .. rst-class:: classref-enumeration-constant
  848. :ref:`BodyState<enum_PhysicsServer3D_BodyState>` **BODY_STATE_ANGULAR_VELOCITY** = ``2``
  849. Constant to set/get the current angular velocity of the body.
  850. .. _class_PhysicsServer3D_constant_BODY_STATE_SLEEPING:
  851. .. rst-class:: classref-enumeration-constant
  852. :ref:`BodyState<enum_PhysicsServer3D_BodyState>` **BODY_STATE_SLEEPING** = ``3``
  853. Constant to sleep/wake up a body, or to get whether it is sleeping.
  854. .. _class_PhysicsServer3D_constant_BODY_STATE_CAN_SLEEP:
  855. .. rst-class:: classref-enumeration-constant
  856. :ref:`BodyState<enum_PhysicsServer3D_BodyState>` **BODY_STATE_CAN_SLEEP** = ``4``
  857. Constant to set/get whether the body can sleep.
  858. .. rst-class:: classref-item-separator
  859. ----
  860. .. _enum_PhysicsServer3D_AreaBodyStatus:
  861. .. rst-class:: classref-enumeration
  862. enum **AreaBodyStatus**:
  863. .. _class_PhysicsServer3D_constant_AREA_BODY_ADDED:
  864. .. rst-class:: classref-enumeration-constant
  865. :ref:`AreaBodyStatus<enum_PhysicsServer3D_AreaBodyStatus>` **AREA_BODY_ADDED** = ``0``
  866. The value of the first parameter and area callback function receives, when an object enters one of its shapes.
  867. .. _class_PhysicsServer3D_constant_AREA_BODY_REMOVED:
  868. .. rst-class:: classref-enumeration-constant
  869. :ref:`AreaBodyStatus<enum_PhysicsServer3D_AreaBodyStatus>` **AREA_BODY_REMOVED** = ``1``
  870. The value of the first parameter and area callback function receives, when an object exits one of its shapes.
  871. .. rst-class:: classref-item-separator
  872. ----
  873. .. _enum_PhysicsServer3D_ProcessInfo:
  874. .. rst-class:: classref-enumeration
  875. enum **ProcessInfo**:
  876. .. _class_PhysicsServer3D_constant_INFO_ACTIVE_OBJECTS:
  877. .. rst-class:: classref-enumeration-constant
  878. :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>` **INFO_ACTIVE_OBJECTS** = ``0``
  879. Constant to get the number of objects that are not sleeping.
  880. .. _class_PhysicsServer3D_constant_INFO_COLLISION_PAIRS:
  881. .. rst-class:: classref-enumeration-constant
  882. :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>` **INFO_COLLISION_PAIRS** = ``1``
  883. Constant to get the number of possible collisions.
  884. .. _class_PhysicsServer3D_constant_INFO_ISLAND_COUNT:
  885. .. rst-class:: classref-enumeration-constant
  886. :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>` **INFO_ISLAND_COUNT** = ``2``
  887. Constant to get the number of space regions where a collision could occur.
  888. .. rst-class:: classref-item-separator
  889. ----
  890. .. _enum_PhysicsServer3D_SpaceParameter:
  891. .. rst-class:: classref-enumeration
  892. enum **SpaceParameter**:
  893. .. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_RECYCLE_RADIUS:
  894. .. rst-class:: classref-enumeration-constant
  895. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_CONTACT_RECYCLE_RADIUS** = ``0``
  896. Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated.
  897. .. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_MAX_SEPARATION:
  898. .. rst-class:: classref-enumeration-constant
  899. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_CONTACT_MAX_SEPARATION** = ``1``
  900. Constant to set/get the maximum distance a shape can be from another before they are considered separated and the contact is discarded.
  901. .. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION:
  902. .. rst-class:: classref-enumeration-constant
  903. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION** = ``2``
  904. Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision.
  905. .. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_DEFAULT_BIAS:
  906. .. rst-class:: classref-enumeration-constant
  907. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_CONTACT_DEFAULT_BIAS** = ``3``
  908. 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.
  909. .. _class_PhysicsServer3D_constant_SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD:
  910. .. rst-class:: classref-enumeration-constant
  911. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD** = ``4``
  912. 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.
  913. .. _class_PhysicsServer3D_constant_SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD:
  914. .. rst-class:: classref-enumeration-constant
  915. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD** = ``5``
  916. 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.
  917. .. _class_PhysicsServer3D_constant_SPACE_PARAM_BODY_TIME_TO_SLEEP:
  918. .. rst-class:: classref-enumeration-constant
  919. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_BODY_TIME_TO_SLEEP** = ``6``
  920. 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.
  921. .. _class_PhysicsServer3D_constant_SPACE_PARAM_SOLVER_ITERATIONS:
  922. .. rst-class:: classref-enumeration-constant
  923. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_SOLVER_ITERATIONS** = ``7``
  924. 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.
  925. .. rst-class:: classref-item-separator
  926. ----
  927. .. _enum_PhysicsServer3D_BodyAxis:
  928. .. rst-class:: classref-enumeration
  929. enum **BodyAxis**:
  930. .. _class_PhysicsServer3D_constant_BODY_AXIS_LINEAR_X:
  931. .. rst-class:: classref-enumeration-constant
  932. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_LINEAR_X** = ``1``
  933. .. _class_PhysicsServer3D_constant_BODY_AXIS_LINEAR_Y:
  934. .. rst-class:: classref-enumeration-constant
  935. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_LINEAR_Y** = ``2``
  936. .. _class_PhysicsServer3D_constant_BODY_AXIS_LINEAR_Z:
  937. .. rst-class:: classref-enumeration-constant
  938. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_LINEAR_Z** = ``4``
  939. .. _class_PhysicsServer3D_constant_BODY_AXIS_ANGULAR_X:
  940. .. rst-class:: classref-enumeration-constant
  941. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_ANGULAR_X** = ``8``
  942. .. _class_PhysicsServer3D_constant_BODY_AXIS_ANGULAR_Y:
  943. .. rst-class:: classref-enumeration-constant
  944. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_ANGULAR_Y** = ``16``
  945. .. _class_PhysicsServer3D_constant_BODY_AXIS_ANGULAR_Z:
  946. .. rst-class:: classref-enumeration-constant
  947. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_ANGULAR_Z** = ``32``
  948. .. rst-class:: classref-section-separator
  949. ----
  950. .. rst-class:: classref-descriptions-group
  951. Method Descriptions
  952. -------------------
  953. .. _class_PhysicsServer3D_method_area_add_shape:
  954. .. rst-class:: classref-method
  955. void **area_add_shape** **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` shape, :ref:`Transform3D<class_Transform3D>` transform=Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), :ref:`bool<class_bool>` disabled=false **)**
  956. 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.
  957. .. rst-class:: classref-item-separator
  958. ----
  959. .. _class_PhysicsServer3D_method_area_attach_object_instance_id:
  960. .. rst-class:: classref-method
  961. void **area_attach_object_instance_id** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)**
  962. Assigns the area to a descendant of :ref:`Object<class_Object>`, so it can exist in the node tree.
  963. .. rst-class:: classref-item-separator
  964. ----
  965. .. _class_PhysicsServer3D_method_area_clear_shapes:
  966. .. rst-class:: classref-method
  967. void **area_clear_shapes** **(** :ref:`RID<class_RID>` area **)**
  968. Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later.
  969. .. rst-class:: classref-item-separator
  970. ----
  971. .. _class_PhysicsServer3D_method_area_create:
  972. .. rst-class:: classref-method
  973. :ref:`RID<class_RID>` **area_create** **(** **)**
  974. Creates an :ref:`Area3D<class_Area3D>`.
  975. .. rst-class:: classref-item-separator
  976. ----
  977. .. _class_PhysicsServer3D_method_area_get_collision_layer:
  978. .. rst-class:: classref-method
  979. :ref:`int<class_int>` **area_get_collision_layer** **(** :ref:`RID<class_RID>` area **)** |const|
  980. Returns the physics layer or layers an area belongs to.
  981. .. rst-class:: classref-item-separator
  982. ----
  983. .. _class_PhysicsServer3D_method_area_get_collision_mask:
  984. .. rst-class:: classref-method
  985. :ref:`int<class_int>` **area_get_collision_mask** **(** :ref:`RID<class_RID>` area **)** |const|
  986. Returns the physics layer or layers an area can contact with.
  987. .. rst-class:: classref-item-separator
  988. ----
  989. .. _class_PhysicsServer3D_method_area_get_object_instance_id:
  990. .. rst-class:: classref-method
  991. :ref:`int<class_int>` **area_get_object_instance_id** **(** :ref:`RID<class_RID>` area **)** |const|
  992. Gets the instance ID of the object the area is assigned to.
  993. .. rst-class:: classref-item-separator
  994. ----
  995. .. _class_PhysicsServer3D_method_area_get_param:
  996. .. rst-class:: classref-method
  997. :ref:`Variant<class_Variant>` **area_get_param** **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` param **)** |const|
  998. Returns an area parameter value. A list of available parameters is on the :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` constants.
  999. .. rst-class:: classref-item-separator
  1000. ----
  1001. .. _class_PhysicsServer3D_method_area_get_shape:
  1002. .. rst-class:: classref-method
  1003. :ref:`RID<class_RID>` **area_get_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |const|
  1004. Returns the :ref:`RID<class_RID>` of the nth shape of an area.
  1005. .. rst-class:: classref-item-separator
  1006. ----
  1007. .. _class_PhysicsServer3D_method_area_get_shape_count:
  1008. .. rst-class:: classref-method
  1009. :ref:`int<class_int>` **area_get_shape_count** **(** :ref:`RID<class_RID>` area **)** |const|
  1010. Returns the number of shapes assigned to an area.
  1011. .. rst-class:: classref-item-separator
  1012. ----
  1013. .. _class_PhysicsServer3D_method_area_get_shape_transform:
  1014. .. rst-class:: classref-method
  1015. :ref:`Transform3D<class_Transform3D>` **area_get_shape_transform** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |const|
  1016. Returns the transform matrix of a shape within an area.
  1017. .. rst-class:: classref-item-separator
  1018. ----
  1019. .. _class_PhysicsServer3D_method_area_get_space:
  1020. .. rst-class:: classref-method
  1021. :ref:`RID<class_RID>` **area_get_space** **(** :ref:`RID<class_RID>` area **)** |const|
  1022. Returns the space assigned to the area.
  1023. .. rst-class:: classref-item-separator
  1024. ----
  1025. .. _class_PhysicsServer3D_method_area_get_transform:
  1026. .. rst-class:: classref-method
  1027. :ref:`Transform3D<class_Transform3D>` **area_get_transform** **(** :ref:`RID<class_RID>` area **)** |const|
  1028. Returns the transform matrix for an area.
  1029. .. rst-class:: classref-item-separator
  1030. ----
  1031. .. _class_PhysicsServer3D_method_area_remove_shape:
  1032. .. rst-class:: classref-method
  1033. void **area_remove_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)**
  1034. Removes a shape from an area. It does not delete the shape, so it can be reassigned later.
  1035. .. rst-class:: classref-item-separator
  1036. ----
  1037. .. _class_PhysicsServer3D_method_area_set_area_monitor_callback:
  1038. .. rst-class:: classref-method
  1039. void **area_set_area_monitor_callback** **(** :ref:`RID<class_RID>` area, :ref:`Callable<class_Callable>` callback **)**
  1040. 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:
  1041. 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,
  1042. 2. an :ref:`RID<class_RID>` ``area_rid``: the :ref:`RID<class_RID>` of the other area that entered or exited the area,
  1043. 3. an integer ``instance_id``: the ``ObjectID`` attached to the other area,
  1044. 4. an integer ``area_shape_idx``: the index of the shape of the other area that entered or exited the area,
  1045. 5. an integer ``self_shape_idx``: the index of the shape of the area where the other area entered or exited.
  1046. 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.
  1047. .. rst-class:: classref-item-separator
  1048. ----
  1049. .. _class_PhysicsServer3D_method_area_set_collision_layer:
  1050. .. rst-class:: classref-method
  1051. void **area_set_collision_layer** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` layer **)**
  1052. Assigns the area to one or many physics layers.
  1053. .. rst-class:: classref-item-separator
  1054. ----
  1055. .. _class_PhysicsServer3D_method_area_set_collision_mask:
  1056. .. rst-class:: classref-method
  1057. void **area_set_collision_mask** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` mask **)**
  1058. Sets which physics layers the area will monitor.
  1059. .. rst-class:: classref-item-separator
  1060. ----
  1061. .. _class_PhysicsServer3D_method_area_set_monitor_callback:
  1062. .. rst-class:: classref-method
  1063. void **area_set_monitor_callback** **(** :ref:`RID<class_RID>` area, :ref:`Callable<class_Callable>` callback **)**
  1064. 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:
  1065. 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,
  1066. 2. an :ref:`RID<class_RID>` ``body_rid``: the :ref:`RID<class_RID>` of the body that entered or exited the area,
  1067. 3. an integer ``instance_id``: the ``ObjectID`` attached to the body,
  1068. 4. an integer ``body_shape_idx``: the index of the shape of the body that entered or exited the area,
  1069. 5. an integer ``self_shape_idx``: the index of the shape of the area where the body entered or exited.
  1070. 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.
  1071. .. rst-class:: classref-item-separator
  1072. ----
  1073. .. _class_PhysicsServer3D_method_area_set_monitorable:
  1074. .. rst-class:: classref-method
  1075. void **area_set_monitorable** **(** :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` monitorable **)**
  1076. .. container:: contribute
  1077. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1078. .. rst-class:: classref-item-separator
  1079. ----
  1080. .. _class_PhysicsServer3D_method_area_set_param:
  1081. .. rst-class:: classref-method
  1082. void **area_set_param** **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` param, :ref:`Variant<class_Variant>` value **)**
  1083. Sets the value for an area parameter. A list of available parameters is on the :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` constants.
  1084. .. rst-class:: classref-item-separator
  1085. ----
  1086. .. _class_PhysicsServer3D_method_area_set_ray_pickable:
  1087. .. rst-class:: classref-method
  1088. void **area_set_ray_pickable** **(** :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` enable **)**
  1089. Sets object pickable with rays.
  1090. .. rst-class:: classref-item-separator
  1091. ----
  1092. .. _class_PhysicsServer3D_method_area_set_shape:
  1093. .. rst-class:: classref-method
  1094. void **area_set_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)**
  1095. Substitutes a given area shape by another. The old shape is selected by its index, the new one by its :ref:`RID<class_RID>`.
  1096. .. rst-class:: classref-item-separator
  1097. ----
  1098. .. _class_PhysicsServer3D_method_area_set_shape_disabled:
  1099. .. rst-class:: classref-method
  1100. void **area_set_shape_disabled** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)**
  1101. .. container:: contribute
  1102. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1103. .. rst-class:: classref-item-separator
  1104. ----
  1105. .. _class_PhysicsServer3D_method_area_set_shape_transform:
  1106. .. rst-class:: classref-method
  1107. void **area_set_shape_transform** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`Transform3D<class_Transform3D>` transform **)**
  1108. Sets the transform matrix for an area shape.
  1109. .. rst-class:: classref-item-separator
  1110. ----
  1111. .. _class_PhysicsServer3D_method_area_set_space:
  1112. .. rst-class:: classref-method
  1113. void **area_set_space** **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` space **)**
  1114. Assigns a space to the area.
  1115. .. rst-class:: classref-item-separator
  1116. ----
  1117. .. _class_PhysicsServer3D_method_area_set_transform:
  1118. .. rst-class:: classref-method
  1119. void **area_set_transform** **(** :ref:`RID<class_RID>` area, :ref:`Transform3D<class_Transform3D>` transform **)**
  1120. Sets the transform matrix for an area.
  1121. .. rst-class:: classref-item-separator
  1122. ----
  1123. .. _class_PhysicsServer3D_method_body_add_collision_exception:
  1124. .. rst-class:: classref-method
  1125. void **body_add_collision_exception** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)**
  1126. Adds a body to the list of bodies exempt from collisions.
  1127. .. rst-class:: classref-item-separator
  1128. ----
  1129. .. _class_PhysicsServer3D_method_body_add_constant_central_force:
  1130. .. rst-class:: classref-method
  1131. void **body_add_constant_central_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` force **)**
  1132. 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))``.
  1133. This is equivalent to using :ref:`body_add_constant_force<class_PhysicsServer3D_method_body_add_constant_force>` at the body's center of mass.
  1134. .. rst-class:: classref-item-separator
  1135. ----
  1136. .. _class_PhysicsServer3D_method_body_add_constant_force:
  1137. .. rst-class:: classref-method
  1138. void **body_add_constant_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` force, :ref:`Vector3<class_Vector3>` position=Vector3(0, 0, 0) **)**
  1139. 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))``.
  1140. \ ``position`` is the offset from the body origin in global coordinates.
  1141. .. rst-class:: classref-item-separator
  1142. ----
  1143. .. _class_PhysicsServer3D_method_body_add_constant_torque:
  1144. .. rst-class:: classref-method
  1145. void **body_add_constant_torque** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` torque **)**
  1146. 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))``.
  1147. .. rst-class:: classref-item-separator
  1148. ----
  1149. .. _class_PhysicsServer3D_method_body_add_shape:
  1150. .. rst-class:: classref-method
  1151. void **body_add_shape** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` shape, :ref:`Transform3D<class_Transform3D>` transform=Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), :ref:`bool<class_bool>` disabled=false **)**
  1152. 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.
  1153. .. rst-class:: classref-item-separator
  1154. ----
  1155. .. _class_PhysicsServer3D_method_body_apply_central_force:
  1156. .. rst-class:: classref-method
  1157. void **body_apply_central_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` force **)**
  1158. Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update.
  1159. This is equivalent to using :ref:`body_apply_force<class_PhysicsServer3D_method_body_apply_force>` at the body's center of mass.
  1160. .. rst-class:: classref-item-separator
  1161. ----
  1162. .. _class_PhysicsServer3D_method_body_apply_central_impulse:
  1163. .. rst-class:: classref-method
  1164. void **body_apply_central_impulse** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` impulse **)**
  1165. Applies a directional impulse without affecting rotation.
  1166. 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).
  1167. This is equivalent to using :ref:`body_apply_impulse<class_PhysicsServer3D_method_body_apply_impulse>` at the body's center of mass.
  1168. .. rst-class:: classref-item-separator
  1169. ----
  1170. .. _class_PhysicsServer3D_method_body_apply_force:
  1171. .. rst-class:: classref-method
  1172. void **body_apply_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` force, :ref:`Vector3<class_Vector3>` position=Vector3(0, 0, 0) **)**
  1173. Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update.
  1174. \ ``position`` is the offset from the body origin in global coordinates.
  1175. .. rst-class:: classref-item-separator
  1176. ----
  1177. .. _class_PhysicsServer3D_method_body_apply_impulse:
  1178. .. rst-class:: classref-method
  1179. void **body_apply_impulse** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` impulse, :ref:`Vector3<class_Vector3>` position=Vector3(0, 0, 0) **)**
  1180. Applies a positioned impulse to the body.
  1181. 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).
  1182. \ ``position`` is the offset from the body origin in global coordinates.
  1183. .. rst-class:: classref-item-separator
  1184. ----
  1185. .. _class_PhysicsServer3D_method_body_apply_torque:
  1186. .. rst-class:: classref-method
  1187. void **body_apply_torque** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` torque **)**
  1188. Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update.
  1189. .. rst-class:: classref-item-separator
  1190. ----
  1191. .. _class_PhysicsServer3D_method_body_apply_torque_impulse:
  1192. .. rst-class:: classref-method
  1193. void **body_apply_torque_impulse** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` impulse **)**
  1194. Applies a rotational impulse to the body without affecting the position.
  1195. 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).
  1196. .. rst-class:: classref-item-separator
  1197. ----
  1198. .. _class_PhysicsServer3D_method_body_attach_object_instance_id:
  1199. .. rst-class:: classref-method
  1200. void **body_attach_object_instance_id** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)**
  1201. Assigns the area to a descendant of :ref:`Object<class_Object>`, so it can exist in the node tree.
  1202. .. rst-class:: classref-item-separator
  1203. ----
  1204. .. _class_PhysicsServer3D_method_body_clear_shapes:
  1205. .. rst-class:: classref-method
  1206. void **body_clear_shapes** **(** :ref:`RID<class_RID>` body **)**
  1207. Removes all shapes from a body.
  1208. .. rst-class:: classref-item-separator
  1209. ----
  1210. .. _class_PhysicsServer3D_method_body_create:
  1211. .. rst-class:: classref-method
  1212. :ref:`RID<class_RID>` **body_create** **(** **)**
  1213. .. container:: contribute
  1214. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1215. .. rst-class:: classref-item-separator
  1216. ----
  1217. .. _class_PhysicsServer3D_method_body_get_collision_layer:
  1218. .. rst-class:: classref-method
  1219. :ref:`int<class_int>` **body_get_collision_layer** **(** :ref:`RID<class_RID>` body **)** |const|
  1220. Returns the physics layer or layers a body belongs to.
  1221. .. rst-class:: classref-item-separator
  1222. ----
  1223. .. _class_PhysicsServer3D_method_body_get_collision_mask:
  1224. .. rst-class:: classref-method
  1225. :ref:`int<class_int>` **body_get_collision_mask** **(** :ref:`RID<class_RID>` body **)** |const|
  1226. Returns the physics layer or layers a body can collide with.
  1227. .. rst-class:: classref-item-separator
  1228. ----
  1229. .. _class_PhysicsServer3D_method_body_get_collision_priority:
  1230. .. rst-class:: classref-method
  1231. :ref:`float<class_float>` **body_get_collision_priority** **(** :ref:`RID<class_RID>` body **)** |const|
  1232. Returns the body's collision priority.
  1233. .. rst-class:: classref-item-separator
  1234. ----
  1235. .. _class_PhysicsServer3D_method_body_get_constant_force:
  1236. .. rst-class:: classref-method
  1237. :ref:`Vector3<class_Vector3>` **body_get_constant_force** **(** :ref:`RID<class_RID>` body **)** |const|
  1238. Returns the body's total constant positional forces applied during each physics update.
  1239. 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>`.
  1240. .. rst-class:: classref-item-separator
  1241. ----
  1242. .. _class_PhysicsServer3D_method_body_get_constant_torque:
  1243. .. rst-class:: classref-method
  1244. :ref:`Vector3<class_Vector3>` **body_get_constant_torque** **(** :ref:`RID<class_RID>` body **)** |const|
  1245. Returns the body's total constant rotational forces applied during each physics update.
  1246. See :ref:`body_add_constant_torque<class_PhysicsServer3D_method_body_add_constant_torque>`.
  1247. .. rst-class:: classref-item-separator
  1248. ----
  1249. .. _class_PhysicsServer3D_method_body_get_direct_state:
  1250. .. rst-class:: classref-method
  1251. :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>` **body_get_direct_state** **(** :ref:`RID<class_RID>` body **)**
  1252. Returns the :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>` of the body. Returns ``null`` if the body is destroyed or removed from the physics space.
  1253. .. rst-class:: classref-item-separator
  1254. ----
  1255. .. _class_PhysicsServer3D_method_body_get_max_contacts_reported:
  1256. .. rst-class:: classref-method
  1257. :ref:`int<class_int>` **body_get_max_contacts_reported** **(** :ref:`RID<class_RID>` body **)** |const|
  1258. Returns the maximum contacts that can be reported. See :ref:`body_set_max_contacts_reported<class_PhysicsServer3D_method_body_set_max_contacts_reported>`.
  1259. .. rst-class:: classref-item-separator
  1260. ----
  1261. .. _class_PhysicsServer3D_method_body_get_mode:
  1262. .. rst-class:: classref-method
  1263. :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **body_get_mode** **(** :ref:`RID<class_RID>` body **)** |const|
  1264. Returns the body mode.
  1265. .. rst-class:: classref-item-separator
  1266. ----
  1267. .. _class_PhysicsServer3D_method_body_get_object_instance_id:
  1268. .. rst-class:: classref-method
  1269. :ref:`int<class_int>` **body_get_object_instance_id** **(** :ref:`RID<class_RID>` body **)** |const|
  1270. Gets the instance ID of the object the area is assigned to.
  1271. .. rst-class:: classref-item-separator
  1272. ----
  1273. .. _class_PhysicsServer3D_method_body_get_param:
  1274. .. rst-class:: classref-method
  1275. :ref:`Variant<class_Variant>` **body_get_param** **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` param **)** |const|
  1276. Returns the value of a body parameter. A list of available parameters is on the :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` constants.
  1277. .. rst-class:: classref-item-separator
  1278. ----
  1279. .. _class_PhysicsServer3D_method_body_get_shape:
  1280. .. rst-class:: classref-method
  1281. :ref:`RID<class_RID>` **body_get_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |const|
  1282. Returns the :ref:`RID<class_RID>` of the nth shape of a body.
  1283. .. rst-class:: classref-item-separator
  1284. ----
  1285. .. _class_PhysicsServer3D_method_body_get_shape_count:
  1286. .. rst-class:: classref-method
  1287. :ref:`int<class_int>` **body_get_shape_count** **(** :ref:`RID<class_RID>` body **)** |const|
  1288. Returns the number of shapes assigned to a body.
  1289. .. rst-class:: classref-item-separator
  1290. ----
  1291. .. _class_PhysicsServer3D_method_body_get_shape_transform:
  1292. .. rst-class:: classref-method
  1293. :ref:`Transform3D<class_Transform3D>` **body_get_shape_transform** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |const|
  1294. Returns the transform matrix of a body shape.
  1295. .. rst-class:: classref-item-separator
  1296. ----
  1297. .. _class_PhysicsServer3D_method_body_get_space:
  1298. .. rst-class:: classref-method
  1299. :ref:`RID<class_RID>` **body_get_space** **(** :ref:`RID<class_RID>` body **)** |const|
  1300. Returns the :ref:`RID<class_RID>` of the space assigned to a body.
  1301. .. rst-class:: classref-item-separator
  1302. ----
  1303. .. _class_PhysicsServer3D_method_body_get_state:
  1304. .. rst-class:: classref-method
  1305. :ref:`Variant<class_Variant>` **body_get_state** **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_PhysicsServer3D_BodyState>` state **)** |const|
  1306. Returns a body state.
  1307. .. rst-class:: classref-item-separator
  1308. ----
  1309. .. _class_PhysicsServer3D_method_body_is_axis_locked:
  1310. .. rst-class:: classref-method
  1311. :ref:`bool<class_bool>` **body_is_axis_locked** **(** :ref:`RID<class_RID>` body, :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` axis **)** |const|
  1312. .. container:: contribute
  1313. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1314. .. rst-class:: classref-item-separator
  1315. ----
  1316. .. _class_PhysicsServer3D_method_body_is_continuous_collision_detection_enabled:
  1317. .. rst-class:: classref-method
  1318. :ref:`bool<class_bool>` **body_is_continuous_collision_detection_enabled** **(** :ref:`RID<class_RID>` body **)** |const|
  1319. If ``true``, the continuous collision detection mode is enabled.
  1320. .. rst-class:: classref-item-separator
  1321. ----
  1322. .. _class_PhysicsServer3D_method_body_is_omitting_force_integration:
  1323. .. rst-class:: classref-method
  1324. :ref:`bool<class_bool>` **body_is_omitting_force_integration** **(** :ref:`RID<class_RID>` body **)** |const|
  1325. Returns whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback<class_PhysicsServer3D_method_body_set_force_integration_callback>`).
  1326. .. rst-class:: classref-item-separator
  1327. ----
  1328. .. _class_PhysicsServer3D_method_body_remove_collision_exception:
  1329. .. rst-class:: classref-method
  1330. void **body_remove_collision_exception** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)**
  1331. Removes a body from the list of bodies exempt from collisions.
  1332. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
  1333. .. rst-class:: classref-item-separator
  1334. ----
  1335. .. _class_PhysicsServer3D_method_body_remove_shape:
  1336. .. rst-class:: classref-method
  1337. void **body_remove_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)**
  1338. Removes a shape from a body. The shape is not deleted, so it can be reused afterwards.
  1339. .. rst-class:: classref-item-separator
  1340. ----
  1341. .. _class_PhysicsServer3D_method_body_reset_mass_properties:
  1342. .. rst-class:: classref-method
  1343. void **body_reset_mass_properties** **(** :ref:`RID<class_RID>` body **)**
  1344. 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>`.
  1345. .. rst-class:: classref-item-separator
  1346. ----
  1347. .. _class_PhysicsServer3D_method_body_set_axis_lock:
  1348. .. rst-class:: classref-method
  1349. void **body_set_axis_lock** **(** :ref:`RID<class_RID>` body, :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` axis, :ref:`bool<class_bool>` lock **)**
  1350. .. container:: contribute
  1351. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1352. .. rst-class:: classref-item-separator
  1353. ----
  1354. .. _class_PhysicsServer3D_method_body_set_axis_velocity:
  1355. .. rst-class:: classref-method
  1356. void **body_set_axis_velocity** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` axis_velocity **)**
  1357. 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.
  1358. .. rst-class:: classref-item-separator
  1359. ----
  1360. .. _class_PhysicsServer3D_method_body_set_collision_layer:
  1361. .. rst-class:: classref-method
  1362. void **body_set_collision_layer** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` layer **)**
  1363. Sets the physics layer or layers a body belongs to.
  1364. .. rst-class:: classref-item-separator
  1365. ----
  1366. .. _class_PhysicsServer3D_method_body_set_collision_mask:
  1367. .. rst-class:: classref-method
  1368. void **body_set_collision_mask** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` mask **)**
  1369. Sets the physics layer or layers a body can collide with.
  1370. .. rst-class:: classref-item-separator
  1371. ----
  1372. .. _class_PhysicsServer3D_method_body_set_collision_priority:
  1373. .. rst-class:: classref-method
  1374. void **body_set_collision_priority** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` priority **)**
  1375. Sets the body's collision priority.
  1376. .. rst-class:: classref-item-separator
  1377. ----
  1378. .. _class_PhysicsServer3D_method_body_set_constant_force:
  1379. .. rst-class:: classref-method
  1380. void **body_set_constant_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` force **)**
  1381. Sets the body's total constant positional forces applied during each physics update.
  1382. 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>`.
  1383. .. rst-class:: classref-item-separator
  1384. ----
  1385. .. _class_PhysicsServer3D_method_body_set_constant_torque:
  1386. .. rst-class:: classref-method
  1387. void **body_set_constant_torque** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` torque **)**
  1388. Sets the body's total constant rotational forces applied during each physics update.
  1389. See :ref:`body_add_constant_torque<class_PhysicsServer3D_method_body_add_constant_torque>`.
  1390. .. rst-class:: classref-item-separator
  1391. ----
  1392. .. _class_PhysicsServer3D_method_body_set_enable_continuous_collision_detection:
  1393. .. rst-class:: classref-method
  1394. void **body_set_enable_continuous_collision_detection** **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)**
  1395. If ``true``, the continuous collision detection mode is enabled.
  1396. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
  1397. .. rst-class:: classref-item-separator
  1398. ----
  1399. .. _class_PhysicsServer3D_method_body_set_force_integration_callback:
  1400. .. rst-class:: classref-method
  1401. void **body_set_force_integration_callback** **(** :ref:`RID<class_RID>` body, :ref:`Callable<class_Callable>` callable, :ref:`Variant<class_Variant>` userdata=null **)**
  1402. Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force_integration<class_PhysicsServer3D_method_body_set_omit_force_integration>`).
  1403. The force integration function takes 2 arguments:
  1404. \ ``state:`` :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>` used to retrieve and modify the body's state.
  1405. \ ``userdata:`` Optional user data, if it was passed when calling ``body_set_force_integration_callback``.
  1406. .. rst-class:: classref-item-separator
  1407. ----
  1408. .. _class_PhysicsServer3D_method_body_set_max_contacts_reported:
  1409. .. rst-class:: classref-method
  1410. void **body_set_max_contacts_reported** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` amount **)**
  1411. 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.
  1412. .. rst-class:: classref-item-separator
  1413. ----
  1414. .. _class_PhysicsServer3D_method_body_set_mode:
  1415. .. rst-class:: classref-method
  1416. void **body_set_mode** **(** :ref:`RID<class_RID>` body, :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` mode **)**
  1417. Sets the body mode, from one of the :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` constants.
  1418. .. rst-class:: classref-item-separator
  1419. ----
  1420. .. _class_PhysicsServer3D_method_body_set_omit_force_integration:
  1421. .. rst-class:: classref-method
  1422. void **body_set_omit_force_integration** **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)**
  1423. Sets whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback<class_PhysicsServer3D_method_body_set_force_integration_callback>`).
  1424. .. rst-class:: classref-item-separator
  1425. ----
  1426. .. _class_PhysicsServer3D_method_body_set_param:
  1427. .. rst-class:: classref-method
  1428. void **body_set_param** **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` param, :ref:`Variant<class_Variant>` value **)**
  1429. Sets a body parameter. A list of available parameters is on the :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` constants.
  1430. .. rst-class:: classref-item-separator
  1431. ----
  1432. .. _class_PhysicsServer3D_method_body_set_ray_pickable:
  1433. .. rst-class:: classref-method
  1434. void **body_set_ray_pickable** **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)**
  1435. Sets the body pickable with rays if ``enable`` is set.
  1436. .. rst-class:: classref-item-separator
  1437. ----
  1438. .. _class_PhysicsServer3D_method_body_set_shape:
  1439. .. rst-class:: classref-method
  1440. void **body_set_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)**
  1441. Substitutes a given body shape by another. The old shape is selected by its index, the new one by its :ref:`RID<class_RID>`.
  1442. .. rst-class:: classref-item-separator
  1443. ----
  1444. .. _class_PhysicsServer3D_method_body_set_shape_disabled:
  1445. .. rst-class:: classref-method
  1446. void **body_set_shape_disabled** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)**
  1447. .. container:: contribute
  1448. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1449. .. rst-class:: classref-item-separator
  1450. ----
  1451. .. _class_PhysicsServer3D_method_body_set_shape_transform:
  1452. .. rst-class:: classref-method
  1453. void **body_set_shape_transform** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`Transform3D<class_Transform3D>` transform **)**
  1454. Sets the transform matrix for a body shape.
  1455. .. rst-class:: classref-item-separator
  1456. ----
  1457. .. _class_PhysicsServer3D_method_body_set_space:
  1458. .. rst-class:: classref-method
  1459. void **body_set_space** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` space **)**
  1460. Assigns a space to the body (see :ref:`space_create<class_PhysicsServer3D_method_space_create>`).
  1461. .. rst-class:: classref-item-separator
  1462. ----
  1463. .. _class_PhysicsServer3D_method_body_set_state:
  1464. .. rst-class:: classref-method
  1465. void **body_set_state** **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_PhysicsServer3D_BodyState>` state, :ref:`Variant<class_Variant>` value **)**
  1466. Sets a body state (see :ref:`BodyState<enum_PhysicsServer3D_BodyState>` constants).
  1467. .. rst-class:: classref-item-separator
  1468. ----
  1469. .. _class_PhysicsServer3D_method_body_test_motion:
  1470. .. rst-class:: classref-method
  1471. :ref:`bool<class_bool>` **body_test_motion** **(** :ref:`RID<class_RID>` body, :ref:`PhysicsTestMotionParameters3D<class_PhysicsTestMotionParameters3D>` parameters, :ref:`PhysicsTestMotionResult3D<class_PhysicsTestMotionResult3D>` result=null **)**
  1472. 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.
  1473. .. rst-class:: classref-item-separator
  1474. ----
  1475. .. _class_PhysicsServer3D_method_box_shape_create:
  1476. .. rst-class:: classref-method
  1477. :ref:`RID<class_RID>` **box_shape_create** **(** **)**
  1478. .. container:: contribute
  1479. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1480. .. rst-class:: classref-item-separator
  1481. ----
  1482. .. _class_PhysicsServer3D_method_capsule_shape_create:
  1483. .. rst-class:: classref-method
  1484. :ref:`RID<class_RID>` **capsule_shape_create** **(** **)**
  1485. .. container:: contribute
  1486. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1487. .. rst-class:: classref-item-separator
  1488. ----
  1489. .. _class_PhysicsServer3D_method_concave_polygon_shape_create:
  1490. .. rst-class:: classref-method
  1491. :ref:`RID<class_RID>` **concave_polygon_shape_create** **(** **)**
  1492. .. container:: contribute
  1493. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1494. .. rst-class:: classref-item-separator
  1495. ----
  1496. .. _class_PhysicsServer3D_method_cone_twist_joint_get_param:
  1497. .. rst-class:: classref-method
  1498. :ref:`float<class_float>` **cone_twist_joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` param **)** |const|
  1499. Gets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` constants).
  1500. .. rst-class:: classref-item-separator
  1501. ----
  1502. .. _class_PhysicsServer3D_method_cone_twist_joint_set_param:
  1503. .. rst-class:: classref-method
  1504. void **cone_twist_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` param, :ref:`float<class_float>` value **)**
  1505. Sets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` constants).
  1506. .. rst-class:: classref-item-separator
  1507. ----
  1508. .. _class_PhysicsServer3D_method_convex_polygon_shape_create:
  1509. .. rst-class:: classref-method
  1510. :ref:`RID<class_RID>` **convex_polygon_shape_create** **(** **)**
  1511. .. container:: contribute
  1512. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1513. .. rst-class:: classref-item-separator
  1514. ----
  1515. .. _class_PhysicsServer3D_method_custom_shape_create:
  1516. .. rst-class:: classref-method
  1517. :ref:`RID<class_RID>` **custom_shape_create** **(** **)**
  1518. .. container:: contribute
  1519. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1520. .. rst-class:: classref-item-separator
  1521. ----
  1522. .. _class_PhysicsServer3D_method_cylinder_shape_create:
  1523. .. rst-class:: classref-method
  1524. :ref:`RID<class_RID>` **cylinder_shape_create** **(** **)**
  1525. .. container:: contribute
  1526. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1527. .. rst-class:: classref-item-separator
  1528. ----
  1529. .. _class_PhysicsServer3D_method_free_rid:
  1530. .. rst-class:: classref-method
  1531. void **free_rid** **(** :ref:`RID<class_RID>` rid **)**
  1532. 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.
  1533. .. rst-class:: classref-item-separator
  1534. ----
  1535. .. _class_PhysicsServer3D_method_generic_6dof_joint_get_flag:
  1536. .. rst-class:: classref-method
  1537. :ref:`bool<class_bool>` **generic_6dof_joint_get_flag** **(** :ref:`RID<class_RID>` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` flag **)** |const|
  1538. Gets a generic_6_DOF_joint flag (see :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` constants).
  1539. .. rst-class:: classref-item-separator
  1540. ----
  1541. .. _class_PhysicsServer3D_method_generic_6dof_joint_get_param:
  1542. .. rst-class:: classref-method
  1543. :ref:`float<class_float>` **generic_6dof_joint_get_param** **(** :ref:`RID<class_RID>` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` param **)** |const|
  1544. Gets a generic_6_DOF_joint parameter (see :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` constants).
  1545. .. rst-class:: classref-item-separator
  1546. ----
  1547. .. _class_PhysicsServer3D_method_generic_6dof_joint_set_flag:
  1548. .. rst-class:: classref-method
  1549. void **generic_6dof_joint_set_flag** **(** :ref:`RID<class_RID>` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` flag, :ref:`bool<class_bool>` enable **)**
  1550. Sets a generic_6_DOF_joint flag (see :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` constants).
  1551. .. rst-class:: classref-item-separator
  1552. ----
  1553. .. _class_PhysicsServer3D_method_generic_6dof_joint_set_param:
  1554. .. rst-class:: classref-method
  1555. void **generic_6dof_joint_set_param** **(** :ref:`RID<class_RID>` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` param, :ref:`float<class_float>` value **)**
  1556. Sets a generic_6_DOF_joint parameter (see :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` constants).
  1557. .. rst-class:: classref-item-separator
  1558. ----
  1559. .. _class_PhysicsServer3D_method_get_process_info:
  1560. .. rst-class:: classref-method
  1561. :ref:`int<class_int>` **get_process_info** **(** :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>` process_info **)**
  1562. Returns information about the current state of the 3D physics engine. See :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>` for a list of available states.
  1563. .. rst-class:: classref-item-separator
  1564. ----
  1565. .. _class_PhysicsServer3D_method_heightmap_shape_create:
  1566. .. rst-class:: classref-method
  1567. :ref:`RID<class_RID>` **heightmap_shape_create** **(** **)**
  1568. .. container:: contribute
  1569. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1570. .. rst-class:: classref-item-separator
  1571. ----
  1572. .. _class_PhysicsServer3D_method_hinge_joint_get_flag:
  1573. .. rst-class:: classref-method
  1574. :ref:`bool<class_bool>` **hinge_joint_get_flag** **(** :ref:`RID<class_RID>` joint, :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` flag **)** |const|
  1575. Gets a hinge_joint flag (see :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` constants).
  1576. .. rst-class:: classref-item-separator
  1577. ----
  1578. .. _class_PhysicsServer3D_method_hinge_joint_get_param:
  1579. .. rst-class:: classref-method
  1580. :ref:`float<class_float>` **hinge_joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` param **)** |const|
  1581. Gets a hinge_joint parameter (see :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>`).
  1582. .. rst-class:: classref-item-separator
  1583. ----
  1584. .. _class_PhysicsServer3D_method_hinge_joint_set_flag:
  1585. .. rst-class:: classref-method
  1586. void **hinge_joint_set_flag** **(** :ref:`RID<class_RID>` joint, :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` flag, :ref:`bool<class_bool>` enabled **)**
  1587. Sets a hinge_joint flag (see :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` constants).
  1588. .. rst-class:: classref-item-separator
  1589. ----
  1590. .. _class_PhysicsServer3D_method_hinge_joint_set_param:
  1591. .. rst-class:: classref-method
  1592. void **hinge_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` param, :ref:`float<class_float>` value **)**
  1593. Sets a hinge_joint parameter (see :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` constants).
  1594. .. rst-class:: classref-item-separator
  1595. ----
  1596. .. _class_PhysicsServer3D_method_joint_clear:
  1597. .. rst-class:: classref-method
  1598. void **joint_clear** **(** :ref:`RID<class_RID>` joint **)**
  1599. .. container:: contribute
  1600. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1601. .. rst-class:: classref-item-separator
  1602. ----
  1603. .. _class_PhysicsServer3D_method_joint_create:
  1604. .. rst-class:: classref-method
  1605. :ref:`RID<class_RID>` **joint_create** **(** **)**
  1606. .. container:: contribute
  1607. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1608. .. rst-class:: classref-item-separator
  1609. ----
  1610. .. _class_PhysicsServer3D_method_joint_disable_collisions_between_bodies:
  1611. .. rst-class:: classref-method
  1612. void **joint_disable_collisions_between_bodies** **(** :ref:`RID<class_RID>` joint, :ref:`bool<class_bool>` disable **)**
  1613. Sets whether the bodies attached to the :ref:`Joint3D<class_Joint3D>` will collide with each other.
  1614. .. rst-class:: classref-item-separator
  1615. ----
  1616. .. _class_PhysicsServer3D_method_joint_get_solver_priority:
  1617. .. rst-class:: classref-method
  1618. :ref:`int<class_int>` **joint_get_solver_priority** **(** :ref:`RID<class_RID>` joint **)** |const|
  1619. Gets the priority value of the Joint3D.
  1620. .. rst-class:: classref-item-separator
  1621. ----
  1622. .. _class_PhysicsServer3D_method_joint_get_type:
  1623. .. rst-class:: classref-method
  1624. :ref:`JointType<enum_PhysicsServer3D_JointType>` **joint_get_type** **(** :ref:`RID<class_RID>` joint **)** |const|
  1625. Returns the type of the Joint3D.
  1626. .. rst-class:: classref-item-separator
  1627. ----
  1628. .. _class_PhysicsServer3D_method_joint_is_disabled_collisions_between_bodies:
  1629. .. rst-class:: classref-method
  1630. :ref:`bool<class_bool>` **joint_is_disabled_collisions_between_bodies** **(** :ref:`RID<class_RID>` joint **)** |const|
  1631. Returns whether the bodies attached to the :ref:`Joint3D<class_Joint3D>` will collide with each other.
  1632. .. rst-class:: classref-item-separator
  1633. ----
  1634. .. _class_PhysicsServer3D_method_joint_make_cone_twist:
  1635. .. rst-class:: classref-method
  1636. void **joint_make_cone_twist** **(** :ref:`RID<class_RID>` joint, :ref:`RID<class_RID>` body_A, :ref:`Transform3D<class_Transform3D>` local_ref_A, :ref:`RID<class_RID>` body_B, :ref:`Transform3D<class_Transform3D>` local_ref_B **)**
  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_joint_make_generic_6dof:
  1642. .. rst-class:: classref-method
  1643. void **joint_make_generic_6dof** **(** :ref:`RID<class_RID>` joint, :ref:`RID<class_RID>` body_A, :ref:`Transform3D<class_Transform3D>` local_ref_A, :ref:`RID<class_RID>` body_B, :ref:`Transform3D<class_Transform3D>` local_ref_B **)**
  1644. .. container:: contribute
  1645. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1646. .. rst-class:: classref-item-separator
  1647. ----
  1648. .. _class_PhysicsServer3D_method_joint_make_hinge:
  1649. .. rst-class:: classref-method
  1650. void **joint_make_hinge** **(** :ref:`RID<class_RID>` joint, :ref:`RID<class_RID>` body_A, :ref:`Transform3D<class_Transform3D>` hinge_A, :ref:`RID<class_RID>` body_B, :ref:`Transform3D<class_Transform3D>` hinge_B **)**
  1651. .. container:: contribute
  1652. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1653. .. rst-class:: classref-item-separator
  1654. ----
  1655. .. _class_PhysicsServer3D_method_joint_make_pin:
  1656. .. rst-class:: classref-method
  1657. void **joint_make_pin** **(** :ref:`RID<class_RID>` joint, :ref:`RID<class_RID>` body_A, :ref:`Vector3<class_Vector3>` local_A, :ref:`RID<class_RID>` body_B, :ref:`Vector3<class_Vector3>` local_B **)**
  1658. .. container:: contribute
  1659. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1660. .. rst-class:: classref-item-separator
  1661. ----
  1662. .. _class_PhysicsServer3D_method_joint_make_slider:
  1663. .. rst-class:: classref-method
  1664. void **joint_make_slider** **(** :ref:`RID<class_RID>` joint, :ref:`RID<class_RID>` body_A, :ref:`Transform3D<class_Transform3D>` local_ref_A, :ref:`RID<class_RID>` body_B, :ref:`Transform3D<class_Transform3D>` local_ref_B **)**
  1665. .. container:: contribute
  1666. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1667. .. rst-class:: classref-item-separator
  1668. ----
  1669. .. _class_PhysicsServer3D_method_joint_set_solver_priority:
  1670. .. rst-class:: classref-method
  1671. void **joint_set_solver_priority** **(** :ref:`RID<class_RID>` joint, :ref:`int<class_int>` priority **)**
  1672. Sets the priority value of the Joint3D.
  1673. .. rst-class:: classref-item-separator
  1674. ----
  1675. .. _class_PhysicsServer3D_method_pin_joint_get_local_a:
  1676. .. rst-class:: classref-method
  1677. :ref:`Vector3<class_Vector3>` **pin_joint_get_local_a** **(** :ref:`RID<class_RID>` joint **)** |const|
  1678. Returns position of the joint in the local space of body a of the joint.
  1679. .. rst-class:: classref-item-separator
  1680. ----
  1681. .. _class_PhysicsServer3D_method_pin_joint_get_local_b:
  1682. .. rst-class:: classref-method
  1683. :ref:`Vector3<class_Vector3>` **pin_joint_get_local_b** **(** :ref:`RID<class_RID>` joint **)** |const|
  1684. Returns position of the joint in the local space of body b of the joint.
  1685. .. rst-class:: classref-item-separator
  1686. ----
  1687. .. _class_PhysicsServer3D_method_pin_joint_get_param:
  1688. .. rst-class:: classref-method
  1689. :ref:`float<class_float>` **pin_joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` param **)** |const|
  1690. Gets a pin_joint parameter (see :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` constants).
  1691. .. rst-class:: classref-item-separator
  1692. ----
  1693. .. _class_PhysicsServer3D_method_pin_joint_set_local_a:
  1694. .. rst-class:: classref-method
  1695. void **pin_joint_set_local_a** **(** :ref:`RID<class_RID>` joint, :ref:`Vector3<class_Vector3>` local_A **)**
  1696. Sets position of the joint in the local space of body a of the joint.
  1697. .. rst-class:: classref-item-separator
  1698. ----
  1699. .. _class_PhysicsServer3D_method_pin_joint_set_local_b:
  1700. .. rst-class:: classref-method
  1701. void **pin_joint_set_local_b** **(** :ref:`RID<class_RID>` joint, :ref:`Vector3<class_Vector3>` local_B **)**
  1702. Sets position of the joint in the local space of body b of the joint.
  1703. .. rst-class:: classref-item-separator
  1704. ----
  1705. .. _class_PhysicsServer3D_method_pin_joint_set_param:
  1706. .. rst-class:: classref-method
  1707. void **pin_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` param, :ref:`float<class_float>` value **)**
  1708. Sets a pin_joint parameter (see :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` constants).
  1709. .. rst-class:: classref-item-separator
  1710. ----
  1711. .. _class_PhysicsServer3D_method_separation_ray_shape_create:
  1712. .. rst-class:: classref-method
  1713. :ref:`RID<class_RID>` **separation_ray_shape_create** **(** **)**
  1714. .. container:: contribute
  1715. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1716. .. rst-class:: classref-item-separator
  1717. ----
  1718. .. _class_PhysicsServer3D_method_set_active:
  1719. .. rst-class:: classref-method
  1720. void **set_active** **(** :ref:`bool<class_bool>` active **)**
  1721. Activates or deactivates the 3D physics engine.
  1722. .. rst-class:: classref-item-separator
  1723. ----
  1724. .. _class_PhysicsServer3D_method_shape_get_data:
  1725. .. rst-class:: classref-method
  1726. :ref:`Variant<class_Variant>` **shape_get_data** **(** :ref:`RID<class_RID>` shape **)** |const|
  1727. Returns the shape data.
  1728. .. rst-class:: classref-item-separator
  1729. ----
  1730. .. _class_PhysicsServer3D_method_shape_get_type:
  1731. .. rst-class:: classref-method
  1732. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **shape_get_type** **(** :ref:`RID<class_RID>` shape **)** |const|
  1733. Returns the type of shape (see :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` constants).
  1734. .. rst-class:: classref-item-separator
  1735. ----
  1736. .. _class_PhysicsServer3D_method_shape_set_data:
  1737. .. rst-class:: classref-method
  1738. void **shape_set_data** **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_Variant>` data **)**
  1739. 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>`.
  1740. .. rst-class:: classref-item-separator
  1741. ----
  1742. .. _class_PhysicsServer3D_method_slider_joint_get_param:
  1743. .. rst-class:: classref-method
  1744. :ref:`float<class_float>` **slider_joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` param **)** |const|
  1745. Gets a slider_joint parameter (see :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` constants).
  1746. .. rst-class:: classref-item-separator
  1747. ----
  1748. .. _class_PhysicsServer3D_method_slider_joint_set_param:
  1749. .. rst-class:: classref-method
  1750. void **slider_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` param, :ref:`float<class_float>` value **)**
  1751. Gets a slider_joint parameter (see :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` constants).
  1752. .. rst-class:: classref-item-separator
  1753. ----
  1754. .. _class_PhysicsServer3D_method_soft_body_get_bounds:
  1755. .. rst-class:: classref-method
  1756. :ref:`AABB<class_AABB>` **soft_body_get_bounds** **(** :ref:`RID<class_RID>` body **)** |const|
  1757. .. container:: contribute
  1758. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1759. .. rst-class:: classref-item-separator
  1760. ----
  1761. .. _class_PhysicsServer3D_method_space_create:
  1762. .. rst-class:: classref-method
  1763. :ref:`RID<class_RID>` **space_create** **(** **)**
  1764. 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>`.
  1765. .. rst-class:: classref-item-separator
  1766. ----
  1767. .. _class_PhysicsServer3D_method_space_get_direct_state:
  1768. .. rst-class:: classref-method
  1769. :ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>` **space_get_direct_state** **(** :ref:`RID<class_RID>` space **)**
  1770. Returns the state of a space, a :ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>`. This object can be used to make collision/intersection queries.
  1771. .. rst-class:: classref-item-separator
  1772. ----
  1773. .. _class_PhysicsServer3D_method_space_get_param:
  1774. .. rst-class:: classref-method
  1775. :ref:`float<class_float>` **space_get_param** **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` param **)** |const|
  1776. Returns the value of a space parameter.
  1777. .. rst-class:: classref-item-separator
  1778. ----
  1779. .. _class_PhysicsServer3D_method_space_is_active:
  1780. .. rst-class:: classref-method
  1781. :ref:`bool<class_bool>` **space_is_active** **(** :ref:`RID<class_RID>` space **)** |const|
  1782. Returns whether the space is active.
  1783. .. rst-class:: classref-item-separator
  1784. ----
  1785. .. _class_PhysicsServer3D_method_space_set_active:
  1786. .. rst-class:: classref-method
  1787. void **space_set_active** **(** :ref:`RID<class_RID>` space, :ref:`bool<class_bool>` active **)**
  1788. Marks a space as active. It will not have an effect, unless it is assigned to an area or body.
  1789. .. rst-class:: classref-item-separator
  1790. ----
  1791. .. _class_PhysicsServer3D_method_space_set_param:
  1792. .. rst-class:: classref-method
  1793. void **space_set_param** **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` param, :ref:`float<class_float>` value **)**
  1794. Sets the value for a space parameter. A list of available parameters is on the :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` constants.
  1795. .. rst-class:: classref-item-separator
  1796. ----
  1797. .. _class_PhysicsServer3D_method_sphere_shape_create:
  1798. .. rst-class:: classref-method
  1799. :ref:`RID<class_RID>` **sphere_shape_create** **(** **)**
  1800. .. container:: contribute
  1801. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1802. .. rst-class:: classref-item-separator
  1803. ----
  1804. .. _class_PhysicsServer3D_method_world_boundary_shape_create:
  1805. .. rst-class:: classref-method
  1806. :ref:`RID<class_RID>` **world_boundary_shape_create** **(** **)**
  1807. .. container:: contribute
  1808. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1809. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  1810. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  1811. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  1812. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  1813. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  1814. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  1815. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`