class_physicsserver3d.rst 264 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer3D.xml.
  6. .. _class_PhysicsServer3D:
  7. PhysicsServer3D
  8. ===============
  9. **Inherits:** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`PhysicsServer3DExtension<class_PhysicsServer3DExtension>`
  11. A server interface for low-level 3D physics access.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. PhysicsServer3D is the server responsible for all 3D physics. It can directly create and manipulate all physics objects:
  16. - A *space* is a self-contained world for a physics simulation. It contains bodies, areas, and joints. Its state can be queried for collision and intersection information, and several parameters of the simulation can be modified.
  17. - A *shape* is a geometric shape such as a sphere, a box, a cylinder, or a polygon. It can be used for collision detection by adding it to a body/area, possibly with an extra transformation relative to the body/area's origin. Bodies/areas can have multiple (transformed) shapes added to them, and a single shape can be added to bodies/areas multiple times with different local transformations.
  18. - A *body* is a physical object which can be in static, kinematic, or rigid mode. Its state (such as position and velocity) can be queried and updated. A force integration callback can be set to customize the body's physics.
  19. - An *area* is a region in space which can be used to detect bodies and areas entering and exiting it. A body monitoring callback can be set to report entering/exiting body shapes, and similarly an area monitoring callback can be set. Gravity and damping can be overridden within the area by setting area parameters.
  20. - A *joint* is a constraint, either between two bodies or on one body relative to a point. Parameters such as the joint bias and the rest length of a spring joint can be adjusted.
  21. Physics objects in **PhysicsServer3D** may be created and manipulated independently; they do not have to be tied to nodes in the scene tree.
  22. \ **Note:** All the 3D physics nodes use the physics server internally. Adding a physics node to the scene tree will cause a corresponding physics object to be created in the physics server. A rigid body node registers a callback that updates the node's transform with the transform of the respective body object in the physics server (every physics update). An area node registers a callback to inform the area node about overlaps with the respective area object in the physics server. The raycast node queries the direct state of the relevant space in the physics server.
  23. .. rst-class:: classref-reftable-group
  24. Methods
  25. -------
  26. .. table::
  27. :widths: auto
  28. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | |void| | :ref:`area_add_shape<class_PhysicsServer3D_method_area_add_shape>`\ (\ area\: :ref:`RID<class_RID>`, shape\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>` = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), disabled\: :ref:`bool<class_bool>` = false\ ) |
  30. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | |void| | :ref:`area_attach_object_instance_id<class_PhysicsServer3D_method_area_attach_object_instance_id>`\ (\ area\: :ref:`RID<class_RID>`, id\: :ref:`int<class_int>`\ ) |
  32. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | |void| | :ref:`area_clear_shapes<class_PhysicsServer3D_method_area_clear_shapes>`\ (\ area\: :ref:`RID<class_RID>`\ ) |
  34. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`RID<class_RID>` | :ref:`area_create<class_PhysicsServer3D_method_area_create>`\ (\ ) |
  36. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | :ref:`int<class_int>` | :ref:`area_get_collision_layer<class_PhysicsServer3D_method_area_get_collision_layer>`\ (\ area\: :ref:`RID<class_RID>`\ ) |const| |
  38. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | :ref:`int<class_int>` | :ref:`area_get_collision_mask<class_PhysicsServer3D_method_area_get_collision_mask>`\ (\ area\: :ref:`RID<class_RID>`\ ) |const| |
  40. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`int<class_int>` | :ref:`area_get_object_instance_id<class_PhysicsServer3D_method_area_get_object_instance_id>`\ (\ area\: :ref:`RID<class_RID>`\ ) |const| |
  42. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | :ref:`Variant<class_Variant>` | :ref:`area_get_param<class_PhysicsServer3D_method_area_get_param>`\ (\ area\: :ref:`RID<class_RID>`, param\: :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>`\ ) |const| |
  44. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | :ref:`RID<class_RID>` | :ref:`area_get_shape<class_PhysicsServer3D_method_area_get_shape>`\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) |const| |
  46. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | :ref:`int<class_int>` | :ref:`area_get_shape_count<class_PhysicsServer3D_method_area_get_shape_count>`\ (\ area\: :ref:`RID<class_RID>`\ ) |const| |
  48. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | :ref:`Transform3D<class_Transform3D>` | :ref:`area_get_shape_transform<class_PhysicsServer3D_method_area_get_shape_transform>`\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) |const| |
  50. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | :ref:`RID<class_RID>` | :ref:`area_get_space<class_PhysicsServer3D_method_area_get_space>`\ (\ area\: :ref:`RID<class_RID>`\ ) |const| |
  52. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | :ref:`Transform3D<class_Transform3D>` | :ref:`area_get_transform<class_PhysicsServer3D_method_area_get_transform>`\ (\ area\: :ref:`RID<class_RID>`\ ) |const| |
  54. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | |void| | :ref:`area_remove_shape<class_PhysicsServer3D_method_area_remove_shape>`\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) |
  56. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | |void| | :ref:`area_set_area_monitor_callback<class_PhysicsServer3D_method_area_set_area_monitor_callback>`\ (\ area\: :ref:`RID<class_RID>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  58. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | |void| | :ref:`area_set_collision_layer<class_PhysicsServer3D_method_area_set_collision_layer>`\ (\ area\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`\ ) |
  60. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | |void| | :ref:`area_set_collision_mask<class_PhysicsServer3D_method_area_set_collision_mask>`\ (\ area\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  62. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | |void| | :ref:`area_set_monitor_callback<class_PhysicsServer3D_method_area_set_monitor_callback>`\ (\ area\: :ref:`RID<class_RID>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  64. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | |void| | :ref:`area_set_monitorable<class_PhysicsServer3D_method_area_set_monitorable>`\ (\ area\: :ref:`RID<class_RID>`, monitorable\: :ref:`bool<class_bool>`\ ) |
  66. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | |void| | :ref:`area_set_param<class_PhysicsServer3D_method_area_set_param>`\ (\ area\: :ref:`RID<class_RID>`, param\: :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>`, value\: :ref:`Variant<class_Variant>`\ ) |
  68. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | |void| | :ref:`area_set_ray_pickable<class_PhysicsServer3D_method_area_set_ray_pickable>`\ (\ area\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  70. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | |void| | :ref:`area_set_shape<class_PhysicsServer3D_method_area_set_shape>`\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, shape\: :ref:`RID<class_RID>`\ ) |
  72. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | |void| | :ref:`area_set_shape_disabled<class_PhysicsServer3D_method_area_set_shape_disabled>`\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ ) |
  74. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | |void| | :ref:`area_set_shape_transform<class_PhysicsServer3D_method_area_set_shape_transform>`\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  76. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | |void| | :ref:`area_set_space<class_PhysicsServer3D_method_area_set_space>`\ (\ area\: :ref:`RID<class_RID>`, space\: :ref:`RID<class_RID>`\ ) |
  78. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | |void| | :ref:`area_set_transform<class_PhysicsServer3D_method_area_set_transform>`\ (\ area\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  80. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | |void| | :ref:`body_add_collision_exception<class_PhysicsServer3D_method_body_add_collision_exception>`\ (\ body\: :ref:`RID<class_RID>`, excepted_body\: :ref:`RID<class_RID>`\ ) |
  82. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | |void| | :ref:`body_add_constant_central_force<class_PhysicsServer3D_method_body_add_constant_central_force>`\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`\ ) |
  84. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | |void| | :ref:`body_add_constant_force<class_PhysicsServer3D_method_body_add_constant_force>`\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) |
  86. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | |void| | :ref:`body_add_constant_torque<class_PhysicsServer3D_method_body_add_constant_torque>`\ (\ body\: :ref:`RID<class_RID>`, torque\: :ref:`Vector3<class_Vector3>`\ ) |
  88. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | |void| | :ref:`body_add_shape<class_PhysicsServer3D_method_body_add_shape>`\ (\ body\: :ref:`RID<class_RID>`, shape\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>` = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), disabled\: :ref:`bool<class_bool>` = false\ ) |
  90. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | |void| | :ref:`body_apply_central_force<class_PhysicsServer3D_method_body_apply_central_force>`\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`\ ) |
  92. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | |void| | :ref:`body_apply_central_impulse<class_PhysicsServer3D_method_body_apply_central_impulse>`\ (\ body\: :ref:`RID<class_RID>`, impulse\: :ref:`Vector3<class_Vector3>`\ ) |
  94. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | |void| | :ref:`body_apply_force<class_PhysicsServer3D_method_body_apply_force>`\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) |
  96. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | |void| | :ref:`body_apply_impulse<class_PhysicsServer3D_method_body_apply_impulse>`\ (\ body\: :ref:`RID<class_RID>`, impulse\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) |
  98. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | |void| | :ref:`body_apply_torque<class_PhysicsServer3D_method_body_apply_torque>`\ (\ body\: :ref:`RID<class_RID>`, torque\: :ref:`Vector3<class_Vector3>`\ ) |
  100. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | |void| | :ref:`body_apply_torque_impulse<class_PhysicsServer3D_method_body_apply_torque_impulse>`\ (\ body\: :ref:`RID<class_RID>`, impulse\: :ref:`Vector3<class_Vector3>`\ ) |
  102. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | |void| | :ref:`body_attach_object_instance_id<class_PhysicsServer3D_method_body_attach_object_instance_id>`\ (\ body\: :ref:`RID<class_RID>`, id\: :ref:`int<class_int>`\ ) |
  104. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | |void| | :ref:`body_clear_shapes<class_PhysicsServer3D_method_body_clear_shapes>`\ (\ body\: :ref:`RID<class_RID>`\ ) |
  106. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | :ref:`RID<class_RID>` | :ref:`body_create<class_PhysicsServer3D_method_body_create>`\ (\ ) |
  108. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | :ref:`int<class_int>` | :ref:`body_get_collision_layer<class_PhysicsServer3D_method_body_get_collision_layer>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  110. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | :ref:`int<class_int>` | :ref:`body_get_collision_mask<class_PhysicsServer3D_method_body_get_collision_mask>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  112. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | :ref:`float<class_float>` | :ref:`body_get_collision_priority<class_PhysicsServer3D_method_body_get_collision_priority>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  114. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | :ref:`Vector3<class_Vector3>` | :ref:`body_get_constant_force<class_PhysicsServer3D_method_body_get_constant_force>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  116. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | :ref:`Vector3<class_Vector3>` | :ref:`body_get_constant_torque<class_PhysicsServer3D_method_body_get_constant_torque>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  118. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>` | :ref:`body_get_direct_state<class_PhysicsServer3D_method_body_get_direct_state>`\ (\ body\: :ref:`RID<class_RID>`\ ) |
  120. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | :ref:`int<class_int>` | :ref:`body_get_max_contacts_reported<class_PhysicsServer3D_method_body_get_max_contacts_reported>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  122. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` | :ref:`body_get_mode<class_PhysicsServer3D_method_body_get_mode>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  124. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | :ref:`int<class_int>` | :ref:`body_get_object_instance_id<class_PhysicsServer3D_method_body_get_object_instance_id>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  126. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | :ref:`Variant<class_Variant>` | :ref:`body_get_param<class_PhysicsServer3D_method_body_get_param>`\ (\ body\: :ref:`RID<class_RID>`, param\: :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>`\ ) |const| |
  128. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | :ref:`RID<class_RID>` | :ref:`body_get_shape<class_PhysicsServer3D_method_body_get_shape>`\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) |const| |
  130. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | :ref:`int<class_int>` | :ref:`body_get_shape_count<class_PhysicsServer3D_method_body_get_shape_count>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  132. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | :ref:`Transform3D<class_Transform3D>` | :ref:`body_get_shape_transform<class_PhysicsServer3D_method_body_get_shape_transform>`\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) |const| |
  134. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | :ref:`RID<class_RID>` | :ref:`body_get_space<class_PhysicsServer3D_method_body_get_space>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  136. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | :ref:`Variant<class_Variant>` | :ref:`body_get_state<class_PhysicsServer3D_method_body_get_state>`\ (\ body\: :ref:`RID<class_RID>`, state\: :ref:`BodyState<enum_PhysicsServer3D_BodyState>`\ ) |const| |
  138. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | :ref:`bool<class_bool>` | :ref:`body_is_axis_locked<class_PhysicsServer3D_method_body_is_axis_locked>`\ (\ body\: :ref:`RID<class_RID>`, axis\: :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>`\ ) |const| |
  140. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | :ref:`bool<class_bool>` | :ref:`body_is_continuous_collision_detection_enabled<class_PhysicsServer3D_method_body_is_continuous_collision_detection_enabled>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  142. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | :ref:`bool<class_bool>` | :ref:`body_is_omitting_force_integration<class_PhysicsServer3D_method_body_is_omitting_force_integration>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  144. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | |void| | :ref:`body_remove_collision_exception<class_PhysicsServer3D_method_body_remove_collision_exception>`\ (\ body\: :ref:`RID<class_RID>`, excepted_body\: :ref:`RID<class_RID>`\ ) |
  146. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | |void| | :ref:`body_remove_shape<class_PhysicsServer3D_method_body_remove_shape>`\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) |
  148. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | |void| | :ref:`body_reset_mass_properties<class_PhysicsServer3D_method_body_reset_mass_properties>`\ (\ body\: :ref:`RID<class_RID>`\ ) |
  150. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | |void| | :ref:`body_set_axis_lock<class_PhysicsServer3D_method_body_set_axis_lock>`\ (\ body\: :ref:`RID<class_RID>`, axis\: :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>`, lock\: :ref:`bool<class_bool>`\ ) |
  152. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | |void| | :ref:`body_set_axis_velocity<class_PhysicsServer3D_method_body_set_axis_velocity>`\ (\ body\: :ref:`RID<class_RID>`, axis_velocity\: :ref:`Vector3<class_Vector3>`\ ) |
  154. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | |void| | :ref:`body_set_collision_layer<class_PhysicsServer3D_method_body_set_collision_layer>`\ (\ body\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`\ ) |
  156. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | |void| | :ref:`body_set_collision_mask<class_PhysicsServer3D_method_body_set_collision_mask>`\ (\ body\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  158. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | |void| | :ref:`body_set_collision_priority<class_PhysicsServer3D_method_body_set_collision_priority>`\ (\ body\: :ref:`RID<class_RID>`, priority\: :ref:`float<class_float>`\ ) |
  160. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | |void| | :ref:`body_set_constant_force<class_PhysicsServer3D_method_body_set_constant_force>`\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`\ ) |
  162. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | |void| | :ref:`body_set_constant_torque<class_PhysicsServer3D_method_body_set_constant_torque>`\ (\ body\: :ref:`RID<class_RID>`, torque\: :ref:`Vector3<class_Vector3>`\ ) |
  164. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. | |void| | :ref:`body_set_enable_continuous_collision_detection<class_PhysicsServer3D_method_body_set_enable_continuous_collision_detection>`\ (\ body\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  166. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  167. | |void| | :ref:`body_set_force_integration_callback<class_PhysicsServer3D_method_body_set_force_integration_callback>`\ (\ body\: :ref:`RID<class_RID>`, callable\: :ref:`Callable<class_Callable>`, userdata\: :ref:`Variant<class_Variant>` = null\ ) |
  168. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  169. | |void| | :ref:`body_set_max_contacts_reported<class_PhysicsServer3D_method_body_set_max_contacts_reported>`\ (\ body\: :ref:`RID<class_RID>`, amount\: :ref:`int<class_int>`\ ) |
  170. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  171. | |void| | :ref:`body_set_mode<class_PhysicsServer3D_method_body_set_mode>`\ (\ body\: :ref:`RID<class_RID>`, mode\: :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>`\ ) |
  172. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  173. | |void| | :ref:`body_set_omit_force_integration<class_PhysicsServer3D_method_body_set_omit_force_integration>`\ (\ body\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  174. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  175. | |void| | :ref:`body_set_param<class_PhysicsServer3D_method_body_set_param>`\ (\ body\: :ref:`RID<class_RID>`, param\: :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>`, value\: :ref:`Variant<class_Variant>`\ ) |
  176. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  177. | |void| | :ref:`body_set_ray_pickable<class_PhysicsServer3D_method_body_set_ray_pickable>`\ (\ body\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  178. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  179. | |void| | :ref:`body_set_shape<class_PhysicsServer3D_method_body_set_shape>`\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, shape\: :ref:`RID<class_RID>`\ ) |
  180. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  181. | |void| | :ref:`body_set_shape_disabled<class_PhysicsServer3D_method_body_set_shape_disabled>`\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ ) |
  182. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | |void| | :ref:`body_set_shape_transform<class_PhysicsServer3D_method_body_set_shape_transform>`\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  184. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | |void| | :ref:`body_set_space<class_PhysicsServer3D_method_body_set_space>`\ (\ body\: :ref:`RID<class_RID>`, space\: :ref:`RID<class_RID>`\ ) |
  186. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | |void| | :ref:`body_set_state<class_PhysicsServer3D_method_body_set_state>`\ (\ body\: :ref:`RID<class_RID>`, state\: :ref:`BodyState<enum_PhysicsServer3D_BodyState>`, value\: :ref:`Variant<class_Variant>`\ ) |
  188. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | |void| | :ref:`body_set_state_sync_callback<class_PhysicsServer3D_method_body_set_state_sync_callback>`\ (\ body\: :ref:`RID<class_RID>`, callable\: :ref:`Callable<class_Callable>`\ ) |
  190. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | :ref:`bool<class_bool>` | :ref:`body_test_motion<class_PhysicsServer3D_method_body_test_motion>`\ (\ body\: :ref:`RID<class_RID>`, parameters\: :ref:`PhysicsTestMotionParameters3D<class_PhysicsTestMotionParameters3D>`, result\: :ref:`PhysicsTestMotionResult3D<class_PhysicsTestMotionResult3D>` = null\ ) |
  192. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | :ref:`RID<class_RID>` | :ref:`box_shape_create<class_PhysicsServer3D_method_box_shape_create>`\ (\ ) |
  194. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | :ref:`RID<class_RID>` | :ref:`capsule_shape_create<class_PhysicsServer3D_method_capsule_shape_create>`\ (\ ) |
  196. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | :ref:`RID<class_RID>` | :ref:`concave_polygon_shape_create<class_PhysicsServer3D_method_concave_polygon_shape_create>`\ (\ ) |
  198. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | :ref:`float<class_float>` | :ref:`cone_twist_joint_get_param<class_PhysicsServer3D_method_cone_twist_joint_get_param>`\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>`\ ) |const| |
  200. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | |void| | :ref:`cone_twist_joint_set_param<class_PhysicsServer3D_method_cone_twist_joint_set_param>`\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>`, value\: :ref:`float<class_float>`\ ) |
  202. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | :ref:`RID<class_RID>` | :ref:`convex_polygon_shape_create<class_PhysicsServer3D_method_convex_polygon_shape_create>`\ (\ ) |
  204. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | :ref:`RID<class_RID>` | :ref:`custom_shape_create<class_PhysicsServer3D_method_custom_shape_create>`\ (\ ) |
  206. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | :ref:`RID<class_RID>` | :ref:`cylinder_shape_create<class_PhysicsServer3D_method_cylinder_shape_create>`\ (\ ) |
  208. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | |void| | :ref:`free_rid<class_PhysicsServer3D_method_free_rid>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  210. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | :ref:`bool<class_bool>` | :ref:`generic_6dof_joint_get_flag<class_PhysicsServer3D_method_generic_6dof_joint_get_flag>`\ (\ joint\: :ref:`RID<class_RID>`, axis\: :ref:`Axis<enum_Vector3_Axis>`, flag\: :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>`\ ) |const| |
  212. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. | :ref:`float<class_float>` | :ref:`generic_6dof_joint_get_param<class_PhysicsServer3D_method_generic_6dof_joint_get_param>`\ (\ joint\: :ref:`RID<class_RID>`, axis\: :ref:`Axis<enum_Vector3_Axis>`, param\: :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>`\ ) |const| |
  214. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  215. | |void| | :ref:`generic_6dof_joint_set_flag<class_PhysicsServer3D_method_generic_6dof_joint_set_flag>`\ (\ joint\: :ref:`RID<class_RID>`, axis\: :ref:`Axis<enum_Vector3_Axis>`, flag\: :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>`, enable\: :ref:`bool<class_bool>`\ ) |
  216. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  217. | |void| | :ref:`generic_6dof_joint_set_param<class_PhysicsServer3D_method_generic_6dof_joint_set_param>`\ (\ joint\: :ref:`RID<class_RID>`, axis\: :ref:`Axis<enum_Vector3_Axis>`, param\: :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>`, value\: :ref:`float<class_float>`\ ) |
  218. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  219. | :ref:`int<class_int>` | :ref:`get_process_info<class_PhysicsServer3D_method_get_process_info>`\ (\ process_info\: :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>`\ ) |
  220. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  221. | :ref:`RID<class_RID>` | :ref:`heightmap_shape_create<class_PhysicsServer3D_method_heightmap_shape_create>`\ (\ ) |
  222. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  223. | :ref:`bool<class_bool>` | :ref:`hinge_joint_get_flag<class_PhysicsServer3D_method_hinge_joint_get_flag>`\ (\ joint\: :ref:`RID<class_RID>`, flag\: :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>`\ ) |const| |
  224. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  225. | :ref:`float<class_float>` | :ref:`hinge_joint_get_param<class_PhysicsServer3D_method_hinge_joint_get_param>`\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>`\ ) |const| |
  226. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  227. | |void| | :ref:`hinge_joint_set_flag<class_PhysicsServer3D_method_hinge_joint_set_flag>`\ (\ joint\: :ref:`RID<class_RID>`, flag\: :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>`, enabled\: :ref:`bool<class_bool>`\ ) |
  228. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  229. | |void| | :ref:`hinge_joint_set_param<class_PhysicsServer3D_method_hinge_joint_set_param>`\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>`, value\: :ref:`float<class_float>`\ ) |
  230. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  231. | |void| | :ref:`joint_clear<class_PhysicsServer3D_method_joint_clear>`\ (\ joint\: :ref:`RID<class_RID>`\ ) |
  232. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  233. | :ref:`RID<class_RID>` | :ref:`joint_create<class_PhysicsServer3D_method_joint_create>`\ (\ ) |
  234. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  235. | |void| | :ref:`joint_disable_collisions_between_bodies<class_PhysicsServer3D_method_joint_disable_collisions_between_bodies>`\ (\ joint\: :ref:`RID<class_RID>`, disable\: :ref:`bool<class_bool>`\ ) |
  236. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  237. | :ref:`int<class_int>` | :ref:`joint_get_solver_priority<class_PhysicsServer3D_method_joint_get_solver_priority>`\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| |
  238. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  239. | :ref:`JointType<enum_PhysicsServer3D_JointType>` | :ref:`joint_get_type<class_PhysicsServer3D_method_joint_get_type>`\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| |
  240. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  241. | :ref:`bool<class_bool>` | :ref:`joint_is_disabled_collisions_between_bodies<class_PhysicsServer3D_method_joint_is_disabled_collisions_between_bodies>`\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| |
  242. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  243. | |void| | :ref:`joint_make_cone_twist<class_PhysicsServer3D_method_joint_make_cone_twist>`\ (\ joint\: :ref:`RID<class_RID>`, body_A\: :ref:`RID<class_RID>`, local_ref_A\: :ref:`Transform3D<class_Transform3D>`, body_B\: :ref:`RID<class_RID>`, local_ref_B\: :ref:`Transform3D<class_Transform3D>`\ ) |
  244. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  245. | |void| | :ref:`joint_make_generic_6dof<class_PhysicsServer3D_method_joint_make_generic_6dof>`\ (\ joint\: :ref:`RID<class_RID>`, body_A\: :ref:`RID<class_RID>`, local_ref_A\: :ref:`Transform3D<class_Transform3D>`, body_B\: :ref:`RID<class_RID>`, local_ref_B\: :ref:`Transform3D<class_Transform3D>`\ ) |
  246. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  247. | |void| | :ref:`joint_make_hinge<class_PhysicsServer3D_method_joint_make_hinge>`\ (\ joint\: :ref:`RID<class_RID>`, body_A\: :ref:`RID<class_RID>`, hinge_A\: :ref:`Transform3D<class_Transform3D>`, body_B\: :ref:`RID<class_RID>`, hinge_B\: :ref:`Transform3D<class_Transform3D>`\ ) |
  248. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  249. | |void| | :ref:`joint_make_pin<class_PhysicsServer3D_method_joint_make_pin>`\ (\ joint\: :ref:`RID<class_RID>`, body_A\: :ref:`RID<class_RID>`, local_A\: :ref:`Vector3<class_Vector3>`, body_B\: :ref:`RID<class_RID>`, local_B\: :ref:`Vector3<class_Vector3>`\ ) |
  250. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  251. | |void| | :ref:`joint_make_slider<class_PhysicsServer3D_method_joint_make_slider>`\ (\ joint\: :ref:`RID<class_RID>`, body_A\: :ref:`RID<class_RID>`, local_ref_A\: :ref:`Transform3D<class_Transform3D>`, body_B\: :ref:`RID<class_RID>`, local_ref_B\: :ref:`Transform3D<class_Transform3D>`\ ) |
  252. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  253. | |void| | :ref:`joint_set_solver_priority<class_PhysicsServer3D_method_joint_set_solver_priority>`\ (\ joint\: :ref:`RID<class_RID>`, priority\: :ref:`int<class_int>`\ ) |
  254. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  255. | :ref:`Vector3<class_Vector3>` | :ref:`pin_joint_get_local_a<class_PhysicsServer3D_method_pin_joint_get_local_a>`\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| |
  256. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  257. | :ref:`Vector3<class_Vector3>` | :ref:`pin_joint_get_local_b<class_PhysicsServer3D_method_pin_joint_get_local_b>`\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| |
  258. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  259. | :ref:`float<class_float>` | :ref:`pin_joint_get_param<class_PhysicsServer3D_method_pin_joint_get_param>`\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>`\ ) |const| |
  260. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  261. | |void| | :ref:`pin_joint_set_local_a<class_PhysicsServer3D_method_pin_joint_set_local_a>`\ (\ joint\: :ref:`RID<class_RID>`, local_A\: :ref:`Vector3<class_Vector3>`\ ) |
  262. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  263. | |void| | :ref:`pin_joint_set_local_b<class_PhysicsServer3D_method_pin_joint_set_local_b>`\ (\ joint\: :ref:`RID<class_RID>`, local_B\: :ref:`Vector3<class_Vector3>`\ ) |
  264. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  265. | |void| | :ref:`pin_joint_set_param<class_PhysicsServer3D_method_pin_joint_set_param>`\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>`, value\: :ref:`float<class_float>`\ ) |
  266. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  267. | :ref:`RID<class_RID>` | :ref:`separation_ray_shape_create<class_PhysicsServer3D_method_separation_ray_shape_create>`\ (\ ) |
  268. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  269. | |void| | :ref:`set_active<class_PhysicsServer3D_method_set_active>`\ (\ active\: :ref:`bool<class_bool>`\ ) |
  270. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  271. | :ref:`Variant<class_Variant>` | :ref:`shape_get_data<class_PhysicsServer3D_method_shape_get_data>`\ (\ shape\: :ref:`RID<class_RID>`\ ) |const| |
  272. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  273. | :ref:`float<class_float>` | :ref:`shape_get_margin<class_PhysicsServer3D_method_shape_get_margin>`\ (\ shape\: :ref:`RID<class_RID>`\ ) |const| |
  274. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  275. | :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` | :ref:`shape_get_type<class_PhysicsServer3D_method_shape_get_type>`\ (\ shape\: :ref:`RID<class_RID>`\ ) |const| |
  276. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  277. | |void| | :ref:`shape_set_data<class_PhysicsServer3D_method_shape_set_data>`\ (\ shape\: :ref:`RID<class_RID>`, data\: :ref:`Variant<class_Variant>`\ ) |
  278. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  279. | |void| | :ref:`shape_set_margin<class_PhysicsServer3D_method_shape_set_margin>`\ (\ shape\: :ref:`RID<class_RID>`, margin\: :ref:`float<class_float>`\ ) |
  280. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  281. | :ref:`float<class_float>` | :ref:`slider_joint_get_param<class_PhysicsServer3D_method_slider_joint_get_param>`\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>`\ ) |const| |
  282. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  283. | |void| | :ref:`slider_joint_set_param<class_PhysicsServer3D_method_slider_joint_set_param>`\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>`, value\: :ref:`float<class_float>`\ ) |
  284. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  285. | |void| | :ref:`soft_body_add_collision_exception<class_PhysicsServer3D_method_soft_body_add_collision_exception>`\ (\ body\: :ref:`RID<class_RID>`, body_b\: :ref:`RID<class_RID>`\ ) |
  286. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  287. | |void| | :ref:`soft_body_apply_central_force<class_PhysicsServer3D_method_soft_body_apply_central_force>`\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`\ ) |
  288. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  289. | |void| | :ref:`soft_body_apply_central_impulse<class_PhysicsServer3D_method_soft_body_apply_central_impulse>`\ (\ body\: :ref:`RID<class_RID>`, impulse\: :ref:`Vector3<class_Vector3>`\ ) |
  290. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  291. | |void| | :ref:`soft_body_apply_point_force<class_PhysicsServer3D_method_soft_body_apply_point_force>`\ (\ body\: :ref:`RID<class_RID>`, point_index\: :ref:`int<class_int>`, force\: :ref:`Vector3<class_Vector3>`\ ) |
  292. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  293. | |void| | :ref:`soft_body_apply_point_impulse<class_PhysicsServer3D_method_soft_body_apply_point_impulse>`\ (\ body\: :ref:`RID<class_RID>`, point_index\: :ref:`int<class_int>`, impulse\: :ref:`Vector3<class_Vector3>`\ ) |
  294. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  295. | :ref:`RID<class_RID>` | :ref:`soft_body_create<class_PhysicsServer3D_method_soft_body_create>`\ (\ ) |
  296. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  297. | :ref:`AABB<class_AABB>` | :ref:`soft_body_get_bounds<class_PhysicsServer3D_method_soft_body_get_bounds>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  298. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  299. | :ref:`int<class_int>` | :ref:`soft_body_get_collision_layer<class_PhysicsServer3D_method_soft_body_get_collision_layer>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  300. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  301. | :ref:`int<class_int>` | :ref:`soft_body_get_collision_mask<class_PhysicsServer3D_method_soft_body_get_collision_mask>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  302. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  303. | :ref:`float<class_float>` | :ref:`soft_body_get_damping_coefficient<class_PhysicsServer3D_method_soft_body_get_damping_coefficient>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  304. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  305. | :ref:`float<class_float>` | :ref:`soft_body_get_drag_coefficient<class_PhysicsServer3D_method_soft_body_get_drag_coefficient>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  306. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  307. | :ref:`float<class_float>` | :ref:`soft_body_get_linear_stiffness<class_PhysicsServer3D_method_soft_body_get_linear_stiffness>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  308. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  309. | :ref:`Vector3<class_Vector3>` | :ref:`soft_body_get_point_global_position<class_PhysicsServer3D_method_soft_body_get_point_global_position>`\ (\ body\: :ref:`RID<class_RID>`, point_index\: :ref:`int<class_int>`\ ) |const| |
  310. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  311. | :ref:`float<class_float>` | :ref:`soft_body_get_pressure_coefficient<class_PhysicsServer3D_method_soft_body_get_pressure_coefficient>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  312. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  313. | :ref:`float<class_float>` | :ref:`soft_body_get_shrinking_factor<class_PhysicsServer3D_method_soft_body_get_shrinking_factor>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  314. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  315. | :ref:`int<class_int>` | :ref:`soft_body_get_simulation_precision<class_PhysicsServer3D_method_soft_body_get_simulation_precision>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  316. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  317. | :ref:`RID<class_RID>` | :ref:`soft_body_get_space<class_PhysicsServer3D_method_soft_body_get_space>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  318. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  319. | :ref:`Variant<class_Variant>` | :ref:`soft_body_get_state<class_PhysicsServer3D_method_soft_body_get_state>`\ (\ body\: :ref:`RID<class_RID>`, state\: :ref:`BodyState<enum_PhysicsServer3D_BodyState>`\ ) |const| |
  320. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  321. | :ref:`float<class_float>` | :ref:`soft_body_get_total_mass<class_PhysicsServer3D_method_soft_body_get_total_mass>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const| |
  322. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  323. | :ref:`bool<class_bool>` | :ref:`soft_body_is_point_pinned<class_PhysicsServer3D_method_soft_body_is_point_pinned>`\ (\ body\: :ref:`RID<class_RID>`, point_index\: :ref:`int<class_int>`\ ) |const| |
  324. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  325. | |void| | :ref:`soft_body_move_point<class_PhysicsServer3D_method_soft_body_move_point>`\ (\ body\: :ref:`RID<class_RID>`, point_index\: :ref:`int<class_int>`, global_position\: :ref:`Vector3<class_Vector3>`\ ) |
  326. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  327. | |void| | :ref:`soft_body_pin_point<class_PhysicsServer3D_method_soft_body_pin_point>`\ (\ body\: :ref:`RID<class_RID>`, point_index\: :ref:`int<class_int>`, pin\: :ref:`bool<class_bool>`\ ) |
  328. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  329. | |void| | :ref:`soft_body_remove_all_pinned_points<class_PhysicsServer3D_method_soft_body_remove_all_pinned_points>`\ (\ body\: :ref:`RID<class_RID>`\ ) |
  330. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  331. | |void| | :ref:`soft_body_remove_collision_exception<class_PhysicsServer3D_method_soft_body_remove_collision_exception>`\ (\ body\: :ref:`RID<class_RID>`, body_b\: :ref:`RID<class_RID>`\ ) |
  332. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  333. | |void| | :ref:`soft_body_set_collision_layer<class_PhysicsServer3D_method_soft_body_set_collision_layer>`\ (\ body\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`\ ) |
  334. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  335. | |void| | :ref:`soft_body_set_collision_mask<class_PhysicsServer3D_method_soft_body_set_collision_mask>`\ (\ body\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  336. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  337. | |void| | :ref:`soft_body_set_damping_coefficient<class_PhysicsServer3D_method_soft_body_set_damping_coefficient>`\ (\ body\: :ref:`RID<class_RID>`, damping_coefficient\: :ref:`float<class_float>`\ ) |
  338. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  339. | |void| | :ref:`soft_body_set_drag_coefficient<class_PhysicsServer3D_method_soft_body_set_drag_coefficient>`\ (\ body\: :ref:`RID<class_RID>`, drag_coefficient\: :ref:`float<class_float>`\ ) |
  340. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  341. | |void| | :ref:`soft_body_set_linear_stiffness<class_PhysicsServer3D_method_soft_body_set_linear_stiffness>`\ (\ body\: :ref:`RID<class_RID>`, stiffness\: :ref:`float<class_float>`\ ) |
  342. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  343. | |void| | :ref:`soft_body_set_mesh<class_PhysicsServer3D_method_soft_body_set_mesh>`\ (\ body\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`\ ) |
  344. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  345. | |void| | :ref:`soft_body_set_pressure_coefficient<class_PhysicsServer3D_method_soft_body_set_pressure_coefficient>`\ (\ body\: :ref:`RID<class_RID>`, pressure_coefficient\: :ref:`float<class_float>`\ ) |
  346. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  347. | |void| | :ref:`soft_body_set_ray_pickable<class_PhysicsServer3D_method_soft_body_set_ray_pickable>`\ (\ body\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  348. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  349. | |void| | :ref:`soft_body_set_shrinking_factor<class_PhysicsServer3D_method_soft_body_set_shrinking_factor>`\ (\ body\: :ref:`RID<class_RID>`, shrinking_factor\: :ref:`float<class_float>`\ ) |
  350. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  351. | |void| | :ref:`soft_body_set_simulation_precision<class_PhysicsServer3D_method_soft_body_set_simulation_precision>`\ (\ body\: :ref:`RID<class_RID>`, simulation_precision\: :ref:`int<class_int>`\ ) |
  352. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  353. | |void| | :ref:`soft_body_set_space<class_PhysicsServer3D_method_soft_body_set_space>`\ (\ body\: :ref:`RID<class_RID>`, space\: :ref:`RID<class_RID>`\ ) |
  354. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  355. | |void| | :ref:`soft_body_set_state<class_PhysicsServer3D_method_soft_body_set_state>`\ (\ body\: :ref:`RID<class_RID>`, state\: :ref:`BodyState<enum_PhysicsServer3D_BodyState>`, variant\: :ref:`Variant<class_Variant>`\ ) |
  356. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  357. | |void| | :ref:`soft_body_set_total_mass<class_PhysicsServer3D_method_soft_body_set_total_mass>`\ (\ body\: :ref:`RID<class_RID>`, total_mass\: :ref:`float<class_float>`\ ) |
  358. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  359. | |void| | :ref:`soft_body_set_transform<class_PhysicsServer3D_method_soft_body_set_transform>`\ (\ body\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  360. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  361. | |void| | :ref:`soft_body_update_rendering_server<class_PhysicsServer3D_method_soft_body_update_rendering_server>`\ (\ body\: :ref:`RID<class_RID>`, rendering_server_handler\: :ref:`PhysicsServer3DRenderingServerHandler<class_PhysicsServer3DRenderingServerHandler>`\ ) |
  362. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  363. | :ref:`RID<class_RID>` | :ref:`space_create<class_PhysicsServer3D_method_space_create>`\ (\ ) |
  364. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  365. | :ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>` | :ref:`space_get_direct_state<class_PhysicsServer3D_method_space_get_direct_state>`\ (\ space\: :ref:`RID<class_RID>`\ ) |
  366. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  367. | :ref:`float<class_float>` | :ref:`space_get_param<class_PhysicsServer3D_method_space_get_param>`\ (\ space\: :ref:`RID<class_RID>`, param\: :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>`\ ) |const| |
  368. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  369. | :ref:`bool<class_bool>` | :ref:`space_is_active<class_PhysicsServer3D_method_space_is_active>`\ (\ space\: :ref:`RID<class_RID>`\ ) |const| |
  370. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  371. | |void| | :ref:`space_set_active<class_PhysicsServer3D_method_space_set_active>`\ (\ space\: :ref:`RID<class_RID>`, active\: :ref:`bool<class_bool>`\ ) |
  372. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  373. | |void| | :ref:`space_set_param<class_PhysicsServer3D_method_space_set_param>`\ (\ space\: :ref:`RID<class_RID>`, param\: :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>`, value\: :ref:`float<class_float>`\ ) |
  374. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  375. | :ref:`RID<class_RID>` | :ref:`sphere_shape_create<class_PhysicsServer3D_method_sphere_shape_create>`\ (\ ) |
  376. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  377. | :ref:`RID<class_RID>` | :ref:`world_boundary_shape_create<class_PhysicsServer3D_method_world_boundary_shape_create>`\ (\ ) |
  378. +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  379. .. rst-class:: classref-section-separator
  380. ----
  381. .. rst-class:: classref-descriptions-group
  382. Enumerations
  383. ------------
  384. .. _enum_PhysicsServer3D_JointType:
  385. .. rst-class:: classref-enumeration
  386. enum **JointType**: :ref:`🔗<enum_PhysicsServer3D_JointType>`
  387. .. _class_PhysicsServer3D_constant_JOINT_TYPE_PIN:
  388. .. rst-class:: classref-enumeration-constant
  389. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_PIN** = ``0``
  390. The :ref:`Joint3D<class_Joint3D>` is a :ref:`PinJoint3D<class_PinJoint3D>`.
  391. .. _class_PhysicsServer3D_constant_JOINT_TYPE_HINGE:
  392. .. rst-class:: classref-enumeration-constant
  393. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_HINGE** = ``1``
  394. The :ref:`Joint3D<class_Joint3D>` is a :ref:`HingeJoint3D<class_HingeJoint3D>`.
  395. .. _class_PhysicsServer3D_constant_JOINT_TYPE_SLIDER:
  396. .. rst-class:: classref-enumeration-constant
  397. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_SLIDER** = ``2``
  398. The :ref:`Joint3D<class_Joint3D>` is a :ref:`SliderJoint3D<class_SliderJoint3D>`.
  399. .. _class_PhysicsServer3D_constant_JOINT_TYPE_CONE_TWIST:
  400. .. rst-class:: classref-enumeration-constant
  401. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_CONE_TWIST** = ``3``
  402. The :ref:`Joint3D<class_Joint3D>` is a :ref:`ConeTwistJoint3D<class_ConeTwistJoint3D>`.
  403. .. _class_PhysicsServer3D_constant_JOINT_TYPE_6DOF:
  404. .. rst-class:: classref-enumeration-constant
  405. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_6DOF** = ``4``
  406. The :ref:`Joint3D<class_Joint3D>` is a :ref:`Generic6DOFJoint3D<class_Generic6DOFJoint3D>`.
  407. .. _class_PhysicsServer3D_constant_JOINT_TYPE_MAX:
  408. .. rst-class:: classref-enumeration-constant
  409. :ref:`JointType<enum_PhysicsServer3D_JointType>` **JOINT_TYPE_MAX** = ``5``
  410. Represents the size of the :ref:`JointType<enum_PhysicsServer3D_JointType>` enum.
  411. .. rst-class:: classref-item-separator
  412. ----
  413. .. _enum_PhysicsServer3D_PinJointParam:
  414. .. rst-class:: classref-enumeration
  415. enum **PinJointParam**: :ref:`🔗<enum_PhysicsServer3D_PinJointParam>`
  416. .. _class_PhysicsServer3D_constant_PIN_JOINT_BIAS:
  417. .. rst-class:: classref-enumeration-constant
  418. :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` **PIN_JOINT_BIAS** = ``0``
  419. The strength with which the pinned objects try to stay in positional relation to each other.
  420. The higher, the stronger.
  421. .. _class_PhysicsServer3D_constant_PIN_JOINT_DAMPING:
  422. .. rst-class:: classref-enumeration-constant
  423. :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` **PIN_JOINT_DAMPING** = ``1``
  424. The strength with which the pinned objects try to stay in velocity relation to each other.
  425. The higher, the stronger.
  426. .. _class_PhysicsServer3D_constant_PIN_JOINT_IMPULSE_CLAMP:
  427. .. rst-class:: classref-enumeration-constant
  428. :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` **PIN_JOINT_IMPULSE_CLAMP** = ``2``
  429. If above 0, this value is the maximum value for an impulse that this Joint3D puts on its ends.
  430. .. rst-class:: classref-item-separator
  431. ----
  432. .. _enum_PhysicsServer3D_HingeJointParam:
  433. .. rst-class:: classref-enumeration
  434. enum **HingeJointParam**: :ref:`🔗<enum_PhysicsServer3D_HingeJointParam>`
  435. .. _class_PhysicsServer3D_constant_HINGE_JOINT_BIAS:
  436. .. rst-class:: classref-enumeration-constant
  437. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_BIAS** = ``0``
  438. The speed with which the two bodies get pulled together when they move in different directions.
  439. .. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_UPPER:
  440. .. rst-class:: classref-enumeration-constant
  441. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_LIMIT_UPPER** = ``1``
  442. The maximum rotation across the Hinge.
  443. .. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_LOWER:
  444. .. rst-class:: classref-enumeration-constant
  445. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_LIMIT_LOWER** = ``2``
  446. The minimum rotation across the Hinge.
  447. .. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_BIAS:
  448. .. rst-class:: classref-enumeration-constant
  449. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_LIMIT_BIAS** = ``3``
  450. The speed with which the rotation across the axis perpendicular to the hinge gets corrected.
  451. .. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_SOFTNESS:
  452. .. rst-class:: classref-enumeration-constant
  453. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_LIMIT_SOFTNESS** = ``4``
  454. .. container:: contribute
  455. There is currently no description for this enum. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  456. .. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_RELAXATION:
  457. .. rst-class:: classref-enumeration-constant
  458. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_LIMIT_RELAXATION** = ``5``
  459. The lower this value, the more the rotation gets slowed down.
  460. .. _class_PhysicsServer3D_constant_HINGE_JOINT_MOTOR_TARGET_VELOCITY:
  461. .. rst-class:: classref-enumeration-constant
  462. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_MOTOR_TARGET_VELOCITY** = ``6``
  463. Target speed for the motor.
  464. .. _class_PhysicsServer3D_constant_HINGE_JOINT_MOTOR_MAX_IMPULSE:
  465. .. rst-class:: classref-enumeration-constant
  466. :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` **HINGE_JOINT_MOTOR_MAX_IMPULSE** = ``7``
  467. Maximum acceleration for the motor.
  468. .. rst-class:: classref-item-separator
  469. ----
  470. .. _enum_PhysicsServer3D_HingeJointFlag:
  471. .. rst-class:: classref-enumeration
  472. enum **HingeJointFlag**: :ref:`🔗<enum_PhysicsServer3D_HingeJointFlag>`
  473. .. _class_PhysicsServer3D_constant_HINGE_JOINT_FLAG_USE_LIMIT:
  474. .. rst-class:: classref-enumeration-constant
  475. :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` **HINGE_JOINT_FLAG_USE_LIMIT** = ``0``
  476. If ``true``, the Hinge has a maximum and a minimum rotation.
  477. .. _class_PhysicsServer3D_constant_HINGE_JOINT_FLAG_ENABLE_MOTOR:
  478. .. rst-class:: classref-enumeration-constant
  479. :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` **HINGE_JOINT_FLAG_ENABLE_MOTOR** = ``1``
  480. If ``true``, a motor turns the Hinge.
  481. .. rst-class:: classref-item-separator
  482. ----
  483. .. _enum_PhysicsServer3D_SliderJointParam:
  484. .. rst-class:: classref-enumeration
  485. enum **SliderJointParam**: :ref:`🔗<enum_PhysicsServer3D_SliderJointParam>`
  486. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_UPPER:
  487. .. rst-class:: classref-enumeration-constant
  488. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_LIMIT_UPPER** = ``0``
  489. The maximum difference between the pivot points on their X axis before damping happens.
  490. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_LOWER:
  491. .. rst-class:: classref-enumeration-constant
  492. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_LIMIT_LOWER** = ``1``
  493. The minimum difference between the pivot points on their X axis before damping happens.
  494. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS:
  495. .. rst-class:: classref-enumeration-constant
  496. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS** = ``2``
  497. A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.
  498. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION:
  499. .. rst-class:: classref-enumeration-constant
  500. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION** = ``3``
  501. The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost.
  502. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_DAMPING:
  503. .. rst-class:: classref-enumeration-constant
  504. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_LIMIT_DAMPING** = ``4``
  505. The amount of damping once the slider limits are surpassed.
  506. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_MOTION_SOFTNESS:
  507. .. rst-class:: classref-enumeration-constant
  508. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_MOTION_SOFTNESS** = ``5``
  509. 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.
  510. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_MOTION_RESTITUTION:
  511. .. rst-class:: classref-enumeration-constant
  512. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_MOTION_RESTITUTION** = ``6``
  513. The amount of restitution inside the slider limits.
  514. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_MOTION_DAMPING:
  515. .. rst-class:: classref-enumeration-constant
  516. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_MOTION_DAMPING** = ``7``
  517. The amount of damping inside the slider limits.
  518. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS:
  519. .. rst-class:: classref-enumeration-constant
  520. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS** = ``8``
  521. A factor applied to the movement across axes orthogonal to the slider.
  522. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION:
  523. .. rst-class:: classref-enumeration-constant
  524. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION** = ``9``
  525. The amount of restitution when movement is across axes orthogonal to the slider.
  526. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING:
  527. .. rst-class:: classref-enumeration-constant
  528. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING** = ``10``
  529. The amount of damping when movement is across axes orthogonal to the slider.
  530. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_UPPER:
  531. .. rst-class:: classref-enumeration-constant
  532. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_LIMIT_UPPER** = ``11``
  533. The upper limit of rotation in the slider.
  534. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_LOWER:
  535. .. rst-class:: classref-enumeration-constant
  536. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_LIMIT_LOWER** = ``12``
  537. The lower limit of rotation in the slider.
  538. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS:
  539. .. rst-class:: classref-enumeration-constant
  540. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS** = ``13``
  541. A factor applied to the all rotation once the limit is surpassed.
  542. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION:
  543. .. rst-class:: classref-enumeration-constant
  544. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION** = ``14``
  545. The amount of restitution of the rotation when the limit is surpassed.
  546. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_DAMPING:
  547. .. rst-class:: classref-enumeration-constant
  548. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_LIMIT_DAMPING** = ``15``
  549. The amount of damping of the rotation when the limit is surpassed.
  550. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS:
  551. .. rst-class:: classref-enumeration-constant
  552. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS** = ``16``
  553. A factor that gets applied to the all rotation in the limits.
  554. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION:
  555. .. rst-class:: classref-enumeration-constant
  556. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION** = ``17``
  557. The amount of restitution of the rotation in the limits.
  558. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_MOTION_DAMPING:
  559. .. rst-class:: classref-enumeration-constant
  560. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_MOTION_DAMPING** = ``18``
  561. The amount of damping of the rotation in the limits.
  562. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS:
  563. .. rst-class:: classref-enumeration-constant
  564. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS** = ``19``
  565. A factor that gets applied to the all rotation across axes orthogonal to the slider.
  566. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION:
  567. .. rst-class:: classref-enumeration-constant
  568. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION** = ``20``
  569. The amount of restitution of the rotation across axes orthogonal to the slider.
  570. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING:
  571. .. rst-class:: classref-enumeration-constant
  572. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING** = ``21``
  573. The amount of damping of the rotation across axes orthogonal to the slider.
  574. .. _class_PhysicsServer3D_constant_SLIDER_JOINT_MAX:
  575. .. rst-class:: classref-enumeration-constant
  576. :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` **SLIDER_JOINT_MAX** = ``22``
  577. Represents the size of the :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` enum.
  578. .. rst-class:: classref-item-separator
  579. ----
  580. .. _enum_PhysicsServer3D_ConeTwistJointParam:
  581. .. rst-class:: classref-enumeration
  582. enum **ConeTwistJointParam**: :ref:`🔗<enum_PhysicsServer3D_ConeTwistJointParam>`
  583. .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_SWING_SPAN:
  584. .. rst-class:: classref-enumeration-constant
  585. :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` **CONE_TWIST_JOINT_SWING_SPAN** = ``0``
  586. Swing is rotation from side to side, around the axis perpendicular to the twist axis.
  587. The swing span defines, how much rotation will not get corrected along the swing axis.
  588. Could be defined as looseness in the :ref:`ConeTwistJoint3D<class_ConeTwistJoint3D>`.
  589. If below 0.05, this behavior is locked.
  590. .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_TWIST_SPAN:
  591. .. rst-class:: classref-enumeration-constant
  592. :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` **CONE_TWIST_JOINT_TWIST_SPAN** = ``1``
  593. Twist is the rotation around the twist axis, this value defined how far the joint can twist.
  594. Twist is locked if below 0.05.
  595. .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_BIAS:
  596. .. rst-class:: classref-enumeration-constant
  597. :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` **CONE_TWIST_JOINT_BIAS** = ``2``
  598. The speed with which the swing or twist will take place.
  599. The higher, the faster.
  600. .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_SOFTNESS:
  601. .. rst-class:: classref-enumeration-constant
  602. :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` **CONE_TWIST_JOINT_SOFTNESS** = ``3``
  603. The ease with which the Joint3D twists, if it's too low, it takes more force to twist the joint.
  604. .. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_RELAXATION:
  605. .. rst-class:: classref-enumeration-constant
  606. :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` **CONE_TWIST_JOINT_RELAXATION** = ``4``
  607. Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
  608. .. rst-class:: classref-item-separator
  609. ----
  610. .. _enum_PhysicsServer3D_G6DOFJointAxisParam:
  611. .. rst-class:: classref-enumeration
  612. enum **G6DOFJointAxisParam**: :ref:`🔗<enum_PhysicsServer3D_G6DOFJointAxisParam>`
  613. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_LOWER_LIMIT:
  614. .. rst-class:: classref-enumeration-constant
  615. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_LOWER_LIMIT** = ``0``
  616. The minimum difference between the pivot points' axes.
  617. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_UPPER_LIMIT:
  618. .. rst-class:: classref-enumeration-constant
  619. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_UPPER_LIMIT** = ``1``
  620. The maximum difference between the pivot points' axes.
  621. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS:
  622. .. rst-class:: classref-enumeration-constant
  623. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS** = ``2``
  624. A factor that gets applied to the movement across the axes. The lower, the slower the movement.
  625. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_RESTITUTION:
  626. .. rst-class:: classref-enumeration-constant
  627. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_RESTITUTION** = ``3``
  628. The amount of restitution on the axes movement. The lower, the more velocity-energy gets lost.
  629. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_DAMPING:
  630. .. rst-class:: classref-enumeration-constant
  631. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_DAMPING** = ``4``
  632. The amount of damping that happens at the linear motion across the axes.
  633. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_MOTOR_TARGET_VELOCITY:
  634. .. rst-class:: classref-enumeration-constant
  635. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_MOTOR_TARGET_VELOCITY** = ``5``
  636. The velocity that the joint's linear motor will attempt to reach.
  637. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_MOTOR_FORCE_LIMIT:
  638. .. rst-class:: classref-enumeration-constant
  639. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_MOTOR_FORCE_LIMIT** = ``6``
  640. The maximum force that the linear motor can apply while trying to reach the target velocity.
  641. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_SPRING_STIFFNESS:
  642. .. rst-class:: classref-enumeration-constant
  643. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_SPRING_STIFFNESS** = ``7``
  644. .. container:: contribute
  645. There is currently no description for this enum. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  646. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_SPRING_DAMPING:
  647. .. rst-class:: classref-enumeration-constant
  648. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_SPRING_DAMPING** = ``8``
  649. .. container:: contribute
  650. There is currently no description for this enum. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  651. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_SPRING_EQUILIBRIUM_POINT:
  652. .. rst-class:: classref-enumeration-constant
  653. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_LINEAR_SPRING_EQUILIBRIUM_POINT** = ``9``
  654. .. container:: contribute
  655. There is currently no description for this enum. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  656. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_LOWER_LIMIT:
  657. .. rst-class:: classref-enumeration-constant
  658. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_LOWER_LIMIT** = ``10``
  659. The minimum rotation in negative direction to break loose and rotate around the axes.
  660. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_UPPER_LIMIT:
  661. .. rst-class:: classref-enumeration-constant
  662. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_UPPER_LIMIT** = ``11``
  663. The minimum rotation in positive direction to break loose and rotate around the axes.
  664. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS:
  665. .. rst-class:: classref-enumeration-constant
  666. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS** = ``12``
  667. A factor that gets multiplied onto all rotations across the axes.
  668. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_DAMPING:
  669. .. rst-class:: classref-enumeration-constant
  670. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_DAMPING** = ``13``
  671. The amount of rotational damping across the axes. The lower, the more damping occurs.
  672. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_RESTITUTION:
  673. .. rst-class:: classref-enumeration-constant
  674. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_RESTITUTION** = ``14``
  675. The amount of rotational restitution across the axes. The lower, the more restitution occurs.
  676. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_FORCE_LIMIT:
  677. .. rst-class:: classref-enumeration-constant
  678. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_FORCE_LIMIT** = ``15``
  679. The maximum amount of force that can occur, when rotating around the axes.
  680. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_ERP:
  681. .. rst-class:: classref-enumeration-constant
  682. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_ERP** = ``16``
  683. 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.
  684. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY:
  685. .. rst-class:: classref-enumeration-constant
  686. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY** = ``17``
  687. Target speed for the motor at the axes.
  688. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT:
  689. .. rst-class:: classref-enumeration-constant
  690. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT** = ``18``
  691. Maximum acceleration for the motor at the axes.
  692. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_SPRING_STIFFNESS:
  693. .. rst-class:: classref-enumeration-constant
  694. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_SPRING_STIFFNESS** = ``19``
  695. .. container:: contribute
  696. There is currently no description for this enum. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  697. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_SPRING_DAMPING:
  698. .. rst-class:: classref-enumeration-constant
  699. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_SPRING_DAMPING** = ``20``
  700. .. container:: contribute
  701. There is currently no description for this enum. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  702. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_SPRING_EQUILIBRIUM_POINT:
  703. .. rst-class:: classref-enumeration-constant
  704. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_ANGULAR_SPRING_EQUILIBRIUM_POINT** = ``21``
  705. .. container:: contribute
  706. There is currently no description for this enum. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  707. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_MAX:
  708. .. rst-class:: classref-enumeration-constant
  709. :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` **G6DOF_JOINT_MAX** = ``22``
  710. Represents the size of the :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` enum.
  711. .. rst-class:: classref-item-separator
  712. ----
  713. .. _enum_PhysicsServer3D_G6DOFJointAxisFlag:
  714. .. rst-class:: classref-enumeration
  715. enum **G6DOFJointAxisFlag**: :ref:`🔗<enum_PhysicsServer3D_G6DOFJointAxisFlag>`
  716. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT:
  717. .. rst-class:: classref-enumeration-constant
  718. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT** = ``0``
  719. If set, linear motion is possible within the given limits.
  720. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT:
  721. .. rst-class:: classref-enumeration-constant
  722. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT** = ``1``
  723. If set, rotational motion is possible.
  724. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_ANGULAR_SPRING:
  725. .. rst-class:: classref-enumeration-constant
  726. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_ANGULAR_SPRING** = ``2``
  727. .. container:: contribute
  728. There is currently no description for this enum. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  729. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_LINEAR_SPRING:
  730. .. rst-class:: classref-enumeration-constant
  731. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_LINEAR_SPRING** = ``3``
  732. .. container:: contribute
  733. There is currently no description for this enum. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  734. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_MOTOR:
  735. .. rst-class:: classref-enumeration-constant
  736. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_MOTOR** = ``4``
  737. If set, there is a rotational motor across these axes.
  738. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR:
  739. .. rst-class:: classref-enumeration-constant
  740. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR** = ``5``
  741. If set, there is a linear motor on this axis that targets a specific velocity.
  742. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_MAX:
  743. .. rst-class:: classref-enumeration-constant
  744. :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` **G6DOF_JOINT_FLAG_MAX** = ``6``
  745. Represents the size of the :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` enum.
  746. .. rst-class:: classref-item-separator
  747. ----
  748. .. _enum_PhysicsServer3D_ShapeType:
  749. .. rst-class:: classref-enumeration
  750. enum **ShapeType**: :ref:`🔗<enum_PhysicsServer3D_ShapeType>`
  751. .. _class_PhysicsServer3D_constant_SHAPE_WORLD_BOUNDARY:
  752. .. rst-class:: classref-enumeration-constant
  753. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_WORLD_BOUNDARY** = ``0``
  754. Constant for creating a world boundary shape (used by the :ref:`WorldBoundaryShape3D<class_WorldBoundaryShape3D>` resource).
  755. .. _class_PhysicsServer3D_constant_SHAPE_SEPARATION_RAY:
  756. .. rst-class:: classref-enumeration-constant
  757. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_SEPARATION_RAY** = ``1``
  758. Constant for creating a separation ray shape (used by the :ref:`SeparationRayShape3D<class_SeparationRayShape3D>` resource).
  759. .. _class_PhysicsServer3D_constant_SHAPE_SPHERE:
  760. .. rst-class:: classref-enumeration-constant
  761. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_SPHERE** = ``2``
  762. Constant for creating a sphere shape (used by the :ref:`SphereShape3D<class_SphereShape3D>` resource).
  763. .. _class_PhysicsServer3D_constant_SHAPE_BOX:
  764. .. rst-class:: classref-enumeration-constant
  765. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_BOX** = ``3``
  766. Constant for creating a box shape (used by the :ref:`BoxShape3D<class_BoxShape3D>` resource).
  767. .. _class_PhysicsServer3D_constant_SHAPE_CAPSULE:
  768. .. rst-class:: classref-enumeration-constant
  769. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_CAPSULE** = ``4``
  770. Constant for creating a capsule shape (used by the :ref:`CapsuleShape3D<class_CapsuleShape3D>` resource).
  771. .. _class_PhysicsServer3D_constant_SHAPE_CYLINDER:
  772. .. rst-class:: classref-enumeration-constant
  773. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_CYLINDER** = ``5``
  774. Constant for creating a cylinder shape (used by the :ref:`CylinderShape3D<class_CylinderShape3D>` resource).
  775. .. _class_PhysicsServer3D_constant_SHAPE_CONVEX_POLYGON:
  776. .. rst-class:: classref-enumeration-constant
  777. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_CONVEX_POLYGON** = ``6``
  778. Constant for creating a convex polygon shape (used by the :ref:`ConvexPolygonShape3D<class_ConvexPolygonShape3D>` resource).
  779. .. _class_PhysicsServer3D_constant_SHAPE_CONCAVE_POLYGON:
  780. .. rst-class:: classref-enumeration-constant
  781. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_CONCAVE_POLYGON** = ``7``
  782. Constant for creating a concave polygon (trimesh) shape (used by the :ref:`ConcavePolygonShape3D<class_ConcavePolygonShape3D>` resource).
  783. .. _class_PhysicsServer3D_constant_SHAPE_HEIGHTMAP:
  784. .. rst-class:: classref-enumeration-constant
  785. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_HEIGHTMAP** = ``8``
  786. Constant for creating a heightmap shape (used by the :ref:`HeightMapShape3D<class_HeightMapShape3D>` resource).
  787. .. _class_PhysicsServer3D_constant_SHAPE_SOFT_BODY:
  788. .. rst-class:: classref-enumeration-constant
  789. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_SOFT_BODY** = ``9``
  790. Constant used internally for a soft body shape. Any attempt to create this kind of shape results in an error.
  791. .. _class_PhysicsServer3D_constant_SHAPE_CUSTOM:
  792. .. rst-class:: classref-enumeration-constant
  793. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **SHAPE_CUSTOM** = ``10``
  794. Constant used internally for a custom shape. Any attempt to create this kind of shape results in an error when using Godot Physics or Jolt Physics.
  795. .. rst-class:: classref-item-separator
  796. ----
  797. .. _enum_PhysicsServer3D_AreaParameter:
  798. .. rst-class:: classref-enumeration
  799. enum **AreaParameter**: :ref:`🔗<enum_PhysicsServer3D_AreaParameter>`
  800. .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_OVERRIDE_MODE:
  801. .. rst-class:: classref-enumeration-constant
  802. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY_OVERRIDE_MODE** = ``0``
  803. Constant to set/get gravity override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` for possible values.
  804. .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY:
  805. .. rst-class:: classref-enumeration-constant
  806. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY** = ``1``
  807. Constant to set/get gravity strength in an area.
  808. .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_VECTOR:
  809. .. rst-class:: classref-enumeration-constant
  810. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY_VECTOR** = ``2``
  811. Constant to set/get gravity vector/center in an area.
  812. .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_IS_POINT:
  813. .. rst-class:: classref-enumeration-constant
  814. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY_IS_POINT** = ``3``
  815. Constant to set/get whether the gravity vector of an area is a direction, or a center point.
  816. .. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_POINT_UNIT_DISTANCE:
  817. .. rst-class:: classref-enumeration-constant
  818. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY_POINT_UNIT_DISTANCE** = ``4``
  819. 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.
  820. 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.
  821. .. _class_PhysicsServer3D_constant_AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE:
  822. .. rst-class:: classref-enumeration-constant
  823. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE** = ``5``
  824. Constant to set/get linear damping override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` for possible values.
  825. .. _class_PhysicsServer3D_constant_AREA_PARAM_LINEAR_DAMP:
  826. .. rst-class:: classref-enumeration-constant
  827. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_LINEAR_DAMP** = ``6``
  828. Constant to set/get the linear damping factor of an area.
  829. .. _class_PhysicsServer3D_constant_AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE:
  830. .. rst-class:: classref-enumeration-constant
  831. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE** = ``7``
  832. Constant to set/get angular damping override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` for possible values.
  833. .. _class_PhysicsServer3D_constant_AREA_PARAM_ANGULAR_DAMP:
  834. .. rst-class:: classref-enumeration-constant
  835. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_ANGULAR_DAMP** = ``8``
  836. Constant to set/get the angular damping factor of an area.
  837. .. _class_PhysicsServer3D_constant_AREA_PARAM_PRIORITY:
  838. .. rst-class:: classref-enumeration-constant
  839. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_PRIORITY** = ``9``
  840. Constant to set/get the priority (order of processing) of an area.
  841. .. _class_PhysicsServer3D_constant_AREA_PARAM_WIND_FORCE_MAGNITUDE:
  842. .. rst-class:: classref-enumeration-constant
  843. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_FORCE_MAGNITUDE** = ``10``
  844. Constant to set/get the magnitude of area-specific wind force. This wind force only applies to :ref:`SoftBody3D<class_SoftBody3D>` nodes. Other physics bodies are currently not affected by wind.
  845. .. _class_PhysicsServer3D_constant_AREA_PARAM_WIND_SOURCE:
  846. .. rst-class:: classref-enumeration-constant
  847. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_SOURCE** = ``11``
  848. Constant to set/get the 3D vector that specifies the origin from which an area-specific wind blows.
  849. .. _class_PhysicsServer3D_constant_AREA_PARAM_WIND_DIRECTION:
  850. .. rst-class:: classref-enumeration-constant
  851. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_DIRECTION** = ``12``
  852. Constant to set/get the 3D vector that specifies the direction in which an area-specific wind blows.
  853. .. _class_PhysicsServer3D_constant_AREA_PARAM_WIND_ATTENUATION_FACTOR:
  854. .. rst-class:: classref-enumeration-constant
  855. :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_ATTENUATION_FACTOR** = ``13``
  856. Constant to set/get the exponential rate at which wind force decreases with distance from its origin.
  857. .. rst-class:: classref-item-separator
  858. ----
  859. .. _enum_PhysicsServer3D_AreaSpaceOverrideMode:
  860. .. rst-class:: classref-enumeration
  861. enum **AreaSpaceOverrideMode**: :ref:`🔗<enum_PhysicsServer3D_AreaSpaceOverrideMode>`
  862. .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_DISABLED:
  863. .. rst-class:: classref-enumeration-constant
  864. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_DISABLED** = ``0``
  865. This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
  866. .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_COMBINE:
  867. .. rst-class:: classref-enumeration-constant
  868. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_COMBINE** = ``1``
  869. 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.
  870. .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_COMBINE_REPLACE:
  871. .. rst-class:: classref-enumeration-constant
  872. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_COMBINE_REPLACE** = ``2``
  873. 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.
  874. .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_REPLACE:
  875. .. rst-class:: classref-enumeration-constant
  876. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_REPLACE** = ``3``
  877. This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
  878. .. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_REPLACE_COMBINE:
  879. .. rst-class:: classref-enumeration-constant
  880. :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_REPLACE_COMBINE** = ``4``
  881. This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
  882. .. rst-class:: classref-item-separator
  883. ----
  884. .. _enum_PhysicsServer3D_BodyMode:
  885. .. rst-class:: classref-enumeration
  886. enum **BodyMode**: :ref:`🔗<enum_PhysicsServer3D_BodyMode>`
  887. .. _class_PhysicsServer3D_constant_BODY_MODE_STATIC:
  888. .. rst-class:: classref-enumeration-constant
  889. :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **BODY_MODE_STATIC** = ``0``
  890. 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.
  891. .. _class_PhysicsServer3D_constant_BODY_MODE_KINEMATIC:
  892. .. rst-class:: classref-enumeration-constant
  893. :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **BODY_MODE_KINEMATIC** = ``1``
  894. Constant for kinematic bodies. In this mode, a body can be only moved by user code and collides with other bodies along its path.
  895. .. _class_PhysicsServer3D_constant_BODY_MODE_RIGID:
  896. .. rst-class:: classref-enumeration-constant
  897. :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **BODY_MODE_RIGID** = ``2``
  898. Constant for rigid bodies. In this mode, a body can be pushed by other bodies and has forces applied.
  899. .. _class_PhysicsServer3D_constant_BODY_MODE_RIGID_LINEAR:
  900. .. rst-class:: classref-enumeration-constant
  901. :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **BODY_MODE_RIGID_LINEAR** = ``3``
  902. Constant for linear rigid bodies. In this mode, a body can not rotate, and only its linear velocity is affected by external forces.
  903. .. rst-class:: classref-item-separator
  904. ----
  905. .. _enum_PhysicsServer3D_BodyParameter:
  906. .. rst-class:: classref-enumeration
  907. enum **BodyParameter**: :ref:`🔗<enum_PhysicsServer3D_BodyParameter>`
  908. .. _class_PhysicsServer3D_constant_BODY_PARAM_BOUNCE:
  909. .. rst-class:: classref-enumeration-constant
  910. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_BOUNCE** = ``0``
  911. Constant to set/get a body's bounce factor.
  912. .. _class_PhysicsServer3D_constant_BODY_PARAM_FRICTION:
  913. .. rst-class:: classref-enumeration-constant
  914. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_FRICTION** = ``1``
  915. Constant to set/get a body's friction.
  916. .. _class_PhysicsServer3D_constant_BODY_PARAM_MASS:
  917. .. rst-class:: classref-enumeration-constant
  918. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_MASS** = ``2``
  919. Constant to set/get a body's mass.
  920. .. _class_PhysicsServer3D_constant_BODY_PARAM_INERTIA:
  921. .. rst-class:: classref-enumeration-constant
  922. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_INERTIA** = ``3``
  923. Constant to set/get a body's inertia.
  924. .. _class_PhysicsServer3D_constant_BODY_PARAM_CENTER_OF_MASS:
  925. .. rst-class:: classref-enumeration-constant
  926. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_CENTER_OF_MASS** = ``4``
  927. Constant to set/get a body's center of mass position in the body's local coordinate system.
  928. .. _class_PhysicsServer3D_constant_BODY_PARAM_GRAVITY_SCALE:
  929. .. rst-class:: classref-enumeration-constant
  930. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_GRAVITY_SCALE** = ``5``
  931. Constant to set/get a body's gravity multiplier.
  932. .. _class_PhysicsServer3D_constant_BODY_PARAM_LINEAR_DAMP_MODE:
  933. .. rst-class:: classref-enumeration-constant
  934. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_LINEAR_DAMP_MODE** = ``6``
  935. Constant to set/get a body's linear damping mode. See :ref:`BodyDampMode<enum_PhysicsServer3D_BodyDampMode>` for possible values.
  936. .. _class_PhysicsServer3D_constant_BODY_PARAM_ANGULAR_DAMP_MODE:
  937. .. rst-class:: classref-enumeration-constant
  938. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_ANGULAR_DAMP_MODE** = ``7``
  939. Constant to set/get a body's angular damping mode. See :ref:`BodyDampMode<enum_PhysicsServer3D_BodyDampMode>` for possible values.
  940. .. _class_PhysicsServer3D_constant_BODY_PARAM_LINEAR_DAMP:
  941. .. rst-class:: classref-enumeration-constant
  942. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_LINEAR_DAMP** = ``8``
  943. Constant to set/get a body's linear damping factor.
  944. .. _class_PhysicsServer3D_constant_BODY_PARAM_ANGULAR_DAMP:
  945. .. rst-class:: classref-enumeration-constant
  946. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_ANGULAR_DAMP** = ``9``
  947. Constant to set/get a body's angular damping factor.
  948. .. _class_PhysicsServer3D_constant_BODY_PARAM_MAX:
  949. .. rst-class:: classref-enumeration-constant
  950. :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` **BODY_PARAM_MAX** = ``10``
  951. Represents the size of the :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` enum.
  952. .. rst-class:: classref-item-separator
  953. ----
  954. .. _enum_PhysicsServer3D_BodyDampMode:
  955. .. rst-class:: classref-enumeration
  956. enum **BodyDampMode**: :ref:`🔗<enum_PhysicsServer3D_BodyDampMode>`
  957. .. _class_PhysicsServer3D_constant_BODY_DAMP_MODE_COMBINE:
  958. .. rst-class:: classref-enumeration-constant
  959. :ref:`BodyDampMode<enum_PhysicsServer3D_BodyDampMode>` **BODY_DAMP_MODE_COMBINE** = ``0``
  960. The body's damping value is added to any value set in areas or the default value.
  961. .. _class_PhysicsServer3D_constant_BODY_DAMP_MODE_REPLACE:
  962. .. rst-class:: classref-enumeration-constant
  963. :ref:`BodyDampMode<enum_PhysicsServer3D_BodyDampMode>` **BODY_DAMP_MODE_REPLACE** = ``1``
  964. The body's damping value replaces any value set in areas or the default value.
  965. .. rst-class:: classref-item-separator
  966. ----
  967. .. _enum_PhysicsServer3D_BodyState:
  968. .. rst-class:: classref-enumeration
  969. enum **BodyState**: :ref:`🔗<enum_PhysicsServer3D_BodyState>`
  970. .. _class_PhysicsServer3D_constant_BODY_STATE_TRANSFORM:
  971. .. rst-class:: classref-enumeration-constant
  972. :ref:`BodyState<enum_PhysicsServer3D_BodyState>` **BODY_STATE_TRANSFORM** = ``0``
  973. Constant to set/get the current transform matrix of the body.
  974. .. _class_PhysicsServer3D_constant_BODY_STATE_LINEAR_VELOCITY:
  975. .. rst-class:: classref-enumeration-constant
  976. :ref:`BodyState<enum_PhysicsServer3D_BodyState>` **BODY_STATE_LINEAR_VELOCITY** = ``1``
  977. Constant to set/get the current linear velocity of the body.
  978. .. _class_PhysicsServer3D_constant_BODY_STATE_ANGULAR_VELOCITY:
  979. .. rst-class:: classref-enumeration-constant
  980. :ref:`BodyState<enum_PhysicsServer3D_BodyState>` **BODY_STATE_ANGULAR_VELOCITY** = ``2``
  981. Constant to set/get the current angular velocity of the body.
  982. .. _class_PhysicsServer3D_constant_BODY_STATE_SLEEPING:
  983. .. rst-class:: classref-enumeration-constant
  984. :ref:`BodyState<enum_PhysicsServer3D_BodyState>` **BODY_STATE_SLEEPING** = ``3``
  985. Constant to sleep/wake up a body, or to get whether it is sleeping.
  986. .. _class_PhysicsServer3D_constant_BODY_STATE_CAN_SLEEP:
  987. .. rst-class:: classref-enumeration-constant
  988. :ref:`BodyState<enum_PhysicsServer3D_BodyState>` **BODY_STATE_CAN_SLEEP** = ``4``
  989. Constant to set/get whether the body can sleep.
  990. .. rst-class:: classref-item-separator
  991. ----
  992. .. _enum_PhysicsServer3D_AreaBodyStatus:
  993. .. rst-class:: classref-enumeration
  994. enum **AreaBodyStatus**: :ref:`🔗<enum_PhysicsServer3D_AreaBodyStatus>`
  995. .. _class_PhysicsServer3D_constant_AREA_BODY_ADDED:
  996. .. rst-class:: classref-enumeration-constant
  997. :ref:`AreaBodyStatus<enum_PhysicsServer3D_AreaBodyStatus>` **AREA_BODY_ADDED** = ``0``
  998. The value of the first parameter and area callback function receives, when an object enters one of its shapes.
  999. .. _class_PhysicsServer3D_constant_AREA_BODY_REMOVED:
  1000. .. rst-class:: classref-enumeration-constant
  1001. :ref:`AreaBodyStatus<enum_PhysicsServer3D_AreaBodyStatus>` **AREA_BODY_REMOVED** = ``1``
  1002. The value of the first parameter and area callback function receives, when an object exits one of its shapes.
  1003. .. rst-class:: classref-item-separator
  1004. ----
  1005. .. _enum_PhysicsServer3D_ProcessInfo:
  1006. .. rst-class:: classref-enumeration
  1007. enum **ProcessInfo**: :ref:`🔗<enum_PhysicsServer3D_ProcessInfo>`
  1008. .. _class_PhysicsServer3D_constant_INFO_ACTIVE_OBJECTS:
  1009. .. rst-class:: classref-enumeration-constant
  1010. :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>` **INFO_ACTIVE_OBJECTS** = ``0``
  1011. Constant to get the number of objects that are not sleeping.
  1012. .. _class_PhysicsServer3D_constant_INFO_COLLISION_PAIRS:
  1013. .. rst-class:: classref-enumeration-constant
  1014. :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>` **INFO_COLLISION_PAIRS** = ``1``
  1015. Constant to get the number of possible collisions.
  1016. .. _class_PhysicsServer3D_constant_INFO_ISLAND_COUNT:
  1017. .. rst-class:: classref-enumeration-constant
  1018. :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>` **INFO_ISLAND_COUNT** = ``2``
  1019. Constant to get the number of space regions where a collision could occur.
  1020. .. rst-class:: classref-item-separator
  1021. ----
  1022. .. _enum_PhysicsServer3D_SpaceParameter:
  1023. .. rst-class:: classref-enumeration
  1024. enum **SpaceParameter**: :ref:`🔗<enum_PhysicsServer3D_SpaceParameter>`
  1025. .. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_RECYCLE_RADIUS:
  1026. .. rst-class:: classref-enumeration-constant
  1027. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_CONTACT_RECYCLE_RADIUS** = ``0``
  1028. Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated.
  1029. .. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_MAX_SEPARATION:
  1030. .. rst-class:: classref-enumeration-constant
  1031. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_CONTACT_MAX_SEPARATION** = ``1``
  1032. Constant to set/get the maximum distance a shape can be from another before they are considered separated and the contact is discarded.
  1033. .. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION:
  1034. .. rst-class:: classref-enumeration-constant
  1035. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION** = ``2``
  1036. Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision.
  1037. .. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_DEFAULT_BIAS:
  1038. .. rst-class:: classref-enumeration-constant
  1039. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_CONTACT_DEFAULT_BIAS** = ``3``
  1040. 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.
  1041. .. _class_PhysicsServer3D_constant_SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD:
  1042. .. rst-class:: classref-enumeration-constant
  1043. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD** = ``4``
  1044. 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.
  1045. .. _class_PhysicsServer3D_constant_SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD:
  1046. .. rst-class:: classref-enumeration-constant
  1047. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD** = ``5``
  1048. 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.
  1049. .. _class_PhysicsServer3D_constant_SPACE_PARAM_BODY_TIME_TO_SLEEP:
  1050. .. rst-class:: classref-enumeration-constant
  1051. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_BODY_TIME_TO_SLEEP** = ``6``
  1052. 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.
  1053. .. _class_PhysicsServer3D_constant_SPACE_PARAM_SOLVER_ITERATIONS:
  1054. .. rst-class:: classref-enumeration-constant
  1055. :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` **SPACE_PARAM_SOLVER_ITERATIONS** = ``7``
  1056. 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.
  1057. .. rst-class:: classref-item-separator
  1058. ----
  1059. .. _enum_PhysicsServer3D_BodyAxis:
  1060. .. rst-class:: classref-enumeration
  1061. enum **BodyAxis**: :ref:`🔗<enum_PhysicsServer3D_BodyAxis>`
  1062. .. _class_PhysicsServer3D_constant_BODY_AXIS_LINEAR_X:
  1063. .. rst-class:: classref-enumeration-constant
  1064. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_LINEAR_X** = ``1``
  1065. .. container:: contribute
  1066. There is currently no description for this enum. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  1067. .. _class_PhysicsServer3D_constant_BODY_AXIS_LINEAR_Y:
  1068. .. rst-class:: classref-enumeration-constant
  1069. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_LINEAR_Y** = ``2``
  1070. .. container:: contribute
  1071. There is currently no description for this enum. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  1072. .. _class_PhysicsServer3D_constant_BODY_AXIS_LINEAR_Z:
  1073. .. rst-class:: classref-enumeration-constant
  1074. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_LINEAR_Z** = ``4``
  1075. .. container:: contribute
  1076. There is currently no description for this enum. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  1077. .. _class_PhysicsServer3D_constant_BODY_AXIS_ANGULAR_X:
  1078. .. rst-class:: classref-enumeration-constant
  1079. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_ANGULAR_X** = ``8``
  1080. .. container:: contribute
  1081. There is currently no description for this enum. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  1082. .. _class_PhysicsServer3D_constant_BODY_AXIS_ANGULAR_Y:
  1083. .. rst-class:: classref-enumeration-constant
  1084. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_ANGULAR_Y** = ``16``
  1085. .. container:: contribute
  1086. There is currently no description for this enum. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  1087. .. _class_PhysicsServer3D_constant_BODY_AXIS_ANGULAR_Z:
  1088. .. rst-class:: classref-enumeration-constant
  1089. :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` **BODY_AXIS_ANGULAR_Z** = ``32``
  1090. .. container:: contribute
  1091. There is currently no description for this enum. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  1092. .. rst-class:: classref-section-separator
  1093. ----
  1094. .. rst-class:: classref-descriptions-group
  1095. Method Descriptions
  1096. -------------------
  1097. .. _class_PhysicsServer3D_method_area_add_shape:
  1098. .. rst-class:: classref-method
  1099. |void| **area_add_shape**\ (\ area\: :ref:`RID<class_RID>`, shape\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>` = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), disabled\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_PhysicsServer3D_method_area_add_shape>`
  1100. 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.
  1101. .. rst-class:: classref-item-separator
  1102. ----
  1103. .. _class_PhysicsServer3D_method_area_attach_object_instance_id:
  1104. .. rst-class:: classref-method
  1105. |void| **area_attach_object_instance_id**\ (\ area\: :ref:`RID<class_RID>`, id\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PhysicsServer3D_method_area_attach_object_instance_id>`
  1106. Assigns the area to a descendant of :ref:`Object<class_Object>`, so it can exist in the node tree.
  1107. .. rst-class:: classref-item-separator
  1108. ----
  1109. .. _class_PhysicsServer3D_method_area_clear_shapes:
  1110. .. rst-class:: classref-method
  1111. |void| **area_clear_shapes**\ (\ area\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_PhysicsServer3D_method_area_clear_shapes>`
  1112. Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later.
  1113. .. rst-class:: classref-item-separator
  1114. ----
  1115. .. _class_PhysicsServer3D_method_area_create:
  1116. .. rst-class:: classref-method
  1117. :ref:`RID<class_RID>` **area_create**\ (\ ) :ref:`🔗<class_PhysicsServer3D_method_area_create>`
  1118. Creates a 3D area object in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. The default settings for the created area include a collision layer and mask set to ``1``, and ``monitorable`` set to ``false``.
  1119. Use :ref:`area_add_shape()<class_PhysicsServer3D_method_area_add_shape>` to add shapes to it, use :ref:`area_set_transform()<class_PhysicsServer3D_method_area_set_transform>` to set its transform, and use :ref:`area_set_space()<class_PhysicsServer3D_method_area_set_space>` to add the area to a space. If you want the area to be detectable use :ref:`area_set_monitorable()<class_PhysicsServer3D_method_area_set_monitorable>`.
  1120. .. rst-class:: classref-item-separator
  1121. ----
  1122. .. _class_PhysicsServer3D_method_area_get_collision_layer:
  1123. .. rst-class:: classref-method
  1124. :ref:`int<class_int>` **area_get_collision_layer**\ (\ area\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_area_get_collision_layer>`
  1125. Returns the physics layer or layers an area belongs to.
  1126. .. rst-class:: classref-item-separator
  1127. ----
  1128. .. _class_PhysicsServer3D_method_area_get_collision_mask:
  1129. .. rst-class:: classref-method
  1130. :ref:`int<class_int>` **area_get_collision_mask**\ (\ area\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_area_get_collision_mask>`
  1131. Returns the physics layer or layers an area can contact with.
  1132. .. rst-class:: classref-item-separator
  1133. ----
  1134. .. _class_PhysicsServer3D_method_area_get_object_instance_id:
  1135. .. rst-class:: classref-method
  1136. :ref:`int<class_int>` **area_get_object_instance_id**\ (\ area\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_area_get_object_instance_id>`
  1137. Gets the instance ID of the object the area is assigned to.
  1138. .. rst-class:: classref-item-separator
  1139. ----
  1140. .. _class_PhysicsServer3D_method_area_get_param:
  1141. .. rst-class:: classref-method
  1142. :ref:`Variant<class_Variant>` **area_get_param**\ (\ area\: :ref:`RID<class_RID>`, param\: :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_area_get_param>`
  1143. Returns an area parameter value. A list of available parameters is on the :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` constants.
  1144. .. rst-class:: classref-item-separator
  1145. ----
  1146. .. _class_PhysicsServer3D_method_area_get_shape:
  1147. .. rst-class:: classref-method
  1148. :ref:`RID<class_RID>` **area_get_shape**\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_area_get_shape>`
  1149. Returns the :ref:`RID<class_RID>` of the nth shape of an area.
  1150. .. rst-class:: classref-item-separator
  1151. ----
  1152. .. _class_PhysicsServer3D_method_area_get_shape_count:
  1153. .. rst-class:: classref-method
  1154. :ref:`int<class_int>` **area_get_shape_count**\ (\ area\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_area_get_shape_count>`
  1155. Returns the number of shapes assigned to an area.
  1156. .. rst-class:: classref-item-separator
  1157. ----
  1158. .. _class_PhysicsServer3D_method_area_get_shape_transform:
  1159. .. rst-class:: classref-method
  1160. :ref:`Transform3D<class_Transform3D>` **area_get_shape_transform**\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_area_get_shape_transform>`
  1161. Returns the transform matrix of a shape within an area.
  1162. .. rst-class:: classref-item-separator
  1163. ----
  1164. .. _class_PhysicsServer3D_method_area_get_space:
  1165. .. rst-class:: classref-method
  1166. :ref:`RID<class_RID>` **area_get_space**\ (\ area\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_area_get_space>`
  1167. Returns the space assigned to the area.
  1168. .. rst-class:: classref-item-separator
  1169. ----
  1170. .. _class_PhysicsServer3D_method_area_get_transform:
  1171. .. rst-class:: classref-method
  1172. :ref:`Transform3D<class_Transform3D>` **area_get_transform**\ (\ area\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_area_get_transform>`
  1173. Returns the transform matrix for an area.
  1174. .. rst-class:: classref-item-separator
  1175. ----
  1176. .. _class_PhysicsServer3D_method_area_remove_shape:
  1177. .. rst-class:: classref-method
  1178. |void| **area_remove_shape**\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PhysicsServer3D_method_area_remove_shape>`
  1179. Removes a shape from an area. It does not delete the shape, so it can be reassigned later.
  1180. .. rst-class:: classref-item-separator
  1181. ----
  1182. .. _class_PhysicsServer3D_method_area_set_area_monitor_callback:
  1183. .. rst-class:: classref-method
  1184. |void| **area_set_area_monitor_callback**\ (\ area\: :ref:`RID<class_RID>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_PhysicsServer3D_method_area_set_area_monitor_callback>`
  1185. 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:
  1186. 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,
  1187. 2. an :ref:`RID<class_RID>` ``area_rid``: the :ref:`RID<class_RID>` of the other area that entered or exited the area,
  1188. 3. an integer ``instance_id``: the ``ObjectID`` attached to the other area,
  1189. 4. an integer ``area_shape_idx``: the index of the shape of the other area that entered or exited the area,
  1190. 5. an integer ``self_shape_idx``: the index of the shape of the area where the other area entered or exited.
  1191. 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.
  1192. .. rst-class:: classref-item-separator
  1193. ----
  1194. .. _class_PhysicsServer3D_method_area_set_collision_layer:
  1195. .. rst-class:: classref-method
  1196. |void| **area_set_collision_layer**\ (\ area\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PhysicsServer3D_method_area_set_collision_layer>`
  1197. Assigns the area to one or many physics layers.
  1198. .. rst-class:: classref-item-separator
  1199. ----
  1200. .. _class_PhysicsServer3D_method_area_set_collision_mask:
  1201. .. rst-class:: classref-method
  1202. |void| **area_set_collision_mask**\ (\ area\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PhysicsServer3D_method_area_set_collision_mask>`
  1203. Sets which physics layers the area will monitor.
  1204. .. rst-class:: classref-item-separator
  1205. ----
  1206. .. _class_PhysicsServer3D_method_area_set_monitor_callback:
  1207. .. rst-class:: classref-method
  1208. |void| **area_set_monitor_callback**\ (\ area\: :ref:`RID<class_RID>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_PhysicsServer3D_method_area_set_monitor_callback>`
  1209. 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:
  1210. 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,
  1211. 2. an :ref:`RID<class_RID>` ``body_rid``: the :ref:`RID<class_RID>` of the body that entered or exited the area,
  1212. 3. an integer ``instance_id``: the ``ObjectID`` attached to the body,
  1213. 4. an integer ``body_shape_idx``: the index of the shape of the body that entered or exited the area,
  1214. 5. an integer ``self_shape_idx``: the index of the shape of the area where the body entered or exited.
  1215. 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.
  1216. .. rst-class:: classref-item-separator
  1217. ----
  1218. .. _class_PhysicsServer3D_method_area_set_monitorable:
  1219. .. rst-class:: classref-method
  1220. |void| **area_set_monitorable**\ (\ area\: :ref:`RID<class_RID>`, monitorable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_PhysicsServer3D_method_area_set_monitorable>`
  1221. .. container:: contribute
  1222. There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  1223. .. rst-class:: classref-item-separator
  1224. ----
  1225. .. _class_PhysicsServer3D_method_area_set_param:
  1226. .. rst-class:: classref-method
  1227. |void| **area_set_param**\ (\ area\: :ref:`RID<class_RID>`, param\: :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_PhysicsServer3D_method_area_set_param>`
  1228. Sets the value for an area parameter. A list of available parameters is on the :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` constants.
  1229. .. rst-class:: classref-item-separator
  1230. ----
  1231. .. _class_PhysicsServer3D_method_area_set_ray_pickable:
  1232. .. rst-class:: classref-method
  1233. |void| **area_set_ray_pickable**\ (\ area\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_PhysicsServer3D_method_area_set_ray_pickable>`
  1234. Sets object pickable with rays.
  1235. .. rst-class:: classref-item-separator
  1236. ----
  1237. .. _class_PhysicsServer3D_method_area_set_shape:
  1238. .. rst-class:: classref-method
  1239. |void| **area_set_shape**\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, shape\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_PhysicsServer3D_method_area_set_shape>`
  1240. Substitutes a given area shape by another. The old shape is selected by its index, the new one by its :ref:`RID<class_RID>`.
  1241. .. rst-class:: classref-item-separator
  1242. ----
  1243. .. _class_PhysicsServer3D_method_area_set_shape_disabled:
  1244. .. rst-class:: classref-method
  1245. |void| **area_set_shape_disabled**\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_PhysicsServer3D_method_area_set_shape_disabled>`
  1246. .. container:: contribute
  1247. There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  1248. .. rst-class:: classref-item-separator
  1249. ----
  1250. .. _class_PhysicsServer3D_method_area_set_shape_transform:
  1251. .. rst-class:: classref-method
  1252. |void| **area_set_shape_transform**\ (\ area\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`🔗<class_PhysicsServer3D_method_area_set_shape_transform>`
  1253. Sets the transform matrix for an area shape.
  1254. .. rst-class:: classref-item-separator
  1255. ----
  1256. .. _class_PhysicsServer3D_method_area_set_space:
  1257. .. rst-class:: classref-method
  1258. |void| **area_set_space**\ (\ area\: :ref:`RID<class_RID>`, space\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_PhysicsServer3D_method_area_set_space>`
  1259. Assigns a space to the area.
  1260. .. rst-class:: classref-item-separator
  1261. ----
  1262. .. _class_PhysicsServer3D_method_area_set_transform:
  1263. .. rst-class:: classref-method
  1264. |void| **area_set_transform**\ (\ area\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`🔗<class_PhysicsServer3D_method_area_set_transform>`
  1265. Sets the transform matrix for an area.
  1266. .. rst-class:: classref-item-separator
  1267. ----
  1268. .. _class_PhysicsServer3D_method_body_add_collision_exception:
  1269. .. rst-class:: classref-method
  1270. |void| **body_add_collision_exception**\ (\ body\: :ref:`RID<class_RID>`, excepted_body\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_add_collision_exception>`
  1271. Adds a body to the list of bodies exempt from collisions.
  1272. .. rst-class:: classref-item-separator
  1273. ----
  1274. .. _class_PhysicsServer3D_method_body_add_constant_central_force:
  1275. .. rst-class:: classref-method
  1276. |void| **body_add_constant_central_force**\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_add_constant_central_force>`
  1277. 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))``.
  1278. This is equivalent to using :ref:`body_add_constant_force()<class_PhysicsServer3D_method_body_add_constant_force>` at the body's center of mass.
  1279. .. rst-class:: classref-item-separator
  1280. ----
  1281. .. _class_PhysicsServer3D_method_body_add_constant_force:
  1282. .. rst-class:: classref-method
  1283. |void| **body_add_constant_force**\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) :ref:`🔗<class_PhysicsServer3D_method_body_add_constant_force>`
  1284. 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))``.
  1285. \ ``position`` is the offset from the body origin in global coordinates.
  1286. .. rst-class:: classref-item-separator
  1287. ----
  1288. .. _class_PhysicsServer3D_method_body_add_constant_torque:
  1289. .. rst-class:: classref-method
  1290. |void| **body_add_constant_torque**\ (\ body\: :ref:`RID<class_RID>`, torque\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_add_constant_torque>`
  1291. 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))``.
  1292. .. rst-class:: classref-item-separator
  1293. ----
  1294. .. _class_PhysicsServer3D_method_body_add_shape:
  1295. .. rst-class:: classref-method
  1296. |void| **body_add_shape**\ (\ body\: :ref:`RID<class_RID>`, shape\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>` = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), disabled\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_PhysicsServer3D_method_body_add_shape>`
  1297. 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.
  1298. .. rst-class:: classref-item-separator
  1299. ----
  1300. .. _class_PhysicsServer3D_method_body_apply_central_force:
  1301. .. rst-class:: classref-method
  1302. |void| **body_apply_central_force**\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_apply_central_force>`
  1303. Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update.
  1304. This is equivalent to using :ref:`body_apply_force()<class_PhysicsServer3D_method_body_apply_force>` at the body's center of mass.
  1305. .. rst-class:: classref-item-separator
  1306. ----
  1307. .. _class_PhysicsServer3D_method_body_apply_central_impulse:
  1308. .. rst-class:: classref-method
  1309. |void| **body_apply_central_impulse**\ (\ body\: :ref:`RID<class_RID>`, impulse\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_apply_central_impulse>`
  1310. Applies a directional impulse without affecting rotation.
  1311. 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).
  1312. This is equivalent to using :ref:`body_apply_impulse()<class_PhysicsServer3D_method_body_apply_impulse>` at the body's center of mass.
  1313. .. rst-class:: classref-item-separator
  1314. ----
  1315. .. _class_PhysicsServer3D_method_body_apply_force:
  1316. .. rst-class:: classref-method
  1317. |void| **body_apply_force**\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) :ref:`🔗<class_PhysicsServer3D_method_body_apply_force>`
  1318. Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update.
  1319. \ ``position`` is the offset from the body origin in global coordinates.
  1320. .. rst-class:: classref-item-separator
  1321. ----
  1322. .. _class_PhysicsServer3D_method_body_apply_impulse:
  1323. .. rst-class:: classref-method
  1324. |void| **body_apply_impulse**\ (\ body\: :ref:`RID<class_RID>`, impulse\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) :ref:`🔗<class_PhysicsServer3D_method_body_apply_impulse>`
  1325. Applies a positioned impulse to the body.
  1326. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
  1327. \ ``position`` is the offset from the body origin in global coordinates.
  1328. .. rst-class:: classref-item-separator
  1329. ----
  1330. .. _class_PhysicsServer3D_method_body_apply_torque:
  1331. .. rst-class:: classref-method
  1332. |void| **body_apply_torque**\ (\ body\: :ref:`RID<class_RID>`, torque\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_apply_torque>`
  1333. Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update.
  1334. .. rst-class:: classref-item-separator
  1335. ----
  1336. .. _class_PhysicsServer3D_method_body_apply_torque_impulse:
  1337. .. rst-class:: classref-method
  1338. |void| **body_apply_torque_impulse**\ (\ body\: :ref:`RID<class_RID>`, impulse\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_apply_torque_impulse>`
  1339. Applies a rotational impulse to the body without affecting the position.
  1340. 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).
  1341. .. rst-class:: classref-item-separator
  1342. ----
  1343. .. _class_PhysicsServer3D_method_body_attach_object_instance_id:
  1344. .. rst-class:: classref-method
  1345. |void| **body_attach_object_instance_id**\ (\ body\: :ref:`RID<class_RID>`, id\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_attach_object_instance_id>`
  1346. Assigns the area to a descendant of :ref:`Object<class_Object>`, so it can exist in the node tree.
  1347. .. rst-class:: classref-item-separator
  1348. ----
  1349. .. _class_PhysicsServer3D_method_body_clear_shapes:
  1350. .. rst-class:: classref-method
  1351. |void| **body_clear_shapes**\ (\ body\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_clear_shapes>`
  1352. Removes all shapes from a body.
  1353. .. rst-class:: classref-item-separator
  1354. ----
  1355. .. _class_PhysicsServer3D_method_body_create:
  1356. .. rst-class:: classref-method
  1357. :ref:`RID<class_RID>` **body_create**\ (\ ) :ref:`🔗<class_PhysicsServer3D_method_body_create>`
  1358. Creates a 3D body object in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. The default settings for the created area include a collision layer and mask set to ``1``, and body mode set to :ref:`BODY_MODE_RIGID<class_PhysicsServer3D_constant_BODY_MODE_RIGID>`.
  1359. Use :ref:`body_add_shape()<class_PhysicsServer3D_method_body_add_shape>` to add shapes to it, use :ref:`body_set_state()<class_PhysicsServer3D_method_body_set_state>` to set its transform, and use :ref:`body_set_space()<class_PhysicsServer3D_method_body_set_space>` to add the body to a space.
  1360. .. rst-class:: classref-item-separator
  1361. ----
  1362. .. _class_PhysicsServer3D_method_body_get_collision_layer:
  1363. .. rst-class:: classref-method
  1364. :ref:`int<class_int>` **body_get_collision_layer**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_body_get_collision_layer>`
  1365. Returns the physics layer or layers a body belongs to.
  1366. .. rst-class:: classref-item-separator
  1367. ----
  1368. .. _class_PhysicsServer3D_method_body_get_collision_mask:
  1369. .. rst-class:: classref-method
  1370. :ref:`int<class_int>` **body_get_collision_mask**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_body_get_collision_mask>`
  1371. Returns the physics layer or layers a body can collide with.
  1372. .. rst-class:: classref-item-separator
  1373. ----
  1374. .. _class_PhysicsServer3D_method_body_get_collision_priority:
  1375. .. rst-class:: classref-method
  1376. :ref:`float<class_float>` **body_get_collision_priority**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_body_get_collision_priority>`
  1377. Returns the body's collision priority.
  1378. .. rst-class:: classref-item-separator
  1379. ----
  1380. .. _class_PhysicsServer3D_method_body_get_constant_force:
  1381. .. rst-class:: classref-method
  1382. :ref:`Vector3<class_Vector3>` **body_get_constant_force**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_body_get_constant_force>`
  1383. Returns the body's total constant positional forces applied during each physics update.
  1384. 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>`.
  1385. .. rst-class:: classref-item-separator
  1386. ----
  1387. .. _class_PhysicsServer3D_method_body_get_constant_torque:
  1388. .. rst-class:: classref-method
  1389. :ref:`Vector3<class_Vector3>` **body_get_constant_torque**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_body_get_constant_torque>`
  1390. Returns the body's total constant rotational forces applied during each physics update.
  1391. See :ref:`body_add_constant_torque()<class_PhysicsServer3D_method_body_add_constant_torque>`.
  1392. .. rst-class:: classref-item-separator
  1393. ----
  1394. .. _class_PhysicsServer3D_method_body_get_direct_state:
  1395. .. rst-class:: classref-method
  1396. :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>` **body_get_direct_state**\ (\ body\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_get_direct_state>`
  1397. Returns the :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>` of the body. Returns ``null`` if the body is destroyed or removed from the physics space.
  1398. .. rst-class:: classref-item-separator
  1399. ----
  1400. .. _class_PhysicsServer3D_method_body_get_max_contacts_reported:
  1401. .. rst-class:: classref-method
  1402. :ref:`int<class_int>` **body_get_max_contacts_reported**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_body_get_max_contacts_reported>`
  1403. Returns the maximum contacts that can be reported. See :ref:`body_set_max_contacts_reported()<class_PhysicsServer3D_method_body_set_max_contacts_reported>`.
  1404. .. rst-class:: classref-item-separator
  1405. ----
  1406. .. _class_PhysicsServer3D_method_body_get_mode:
  1407. .. rst-class:: classref-method
  1408. :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **body_get_mode**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_body_get_mode>`
  1409. Returns the body mode.
  1410. .. rst-class:: classref-item-separator
  1411. ----
  1412. .. _class_PhysicsServer3D_method_body_get_object_instance_id:
  1413. .. rst-class:: classref-method
  1414. :ref:`int<class_int>` **body_get_object_instance_id**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_body_get_object_instance_id>`
  1415. Gets the instance ID of the object the area is assigned to.
  1416. .. rst-class:: classref-item-separator
  1417. ----
  1418. .. _class_PhysicsServer3D_method_body_get_param:
  1419. .. rst-class:: classref-method
  1420. :ref:`Variant<class_Variant>` **body_get_param**\ (\ body\: :ref:`RID<class_RID>`, param\: :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_body_get_param>`
  1421. Returns the value of a body parameter. A list of available parameters is on the :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` constants.
  1422. .. rst-class:: classref-item-separator
  1423. ----
  1424. .. _class_PhysicsServer3D_method_body_get_shape:
  1425. .. rst-class:: classref-method
  1426. :ref:`RID<class_RID>` **body_get_shape**\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_body_get_shape>`
  1427. Returns the :ref:`RID<class_RID>` of the nth shape of a body.
  1428. .. rst-class:: classref-item-separator
  1429. ----
  1430. .. _class_PhysicsServer3D_method_body_get_shape_count:
  1431. .. rst-class:: classref-method
  1432. :ref:`int<class_int>` **body_get_shape_count**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_body_get_shape_count>`
  1433. Returns the number of shapes assigned to a body.
  1434. .. rst-class:: classref-item-separator
  1435. ----
  1436. .. _class_PhysicsServer3D_method_body_get_shape_transform:
  1437. .. rst-class:: classref-method
  1438. :ref:`Transform3D<class_Transform3D>` **body_get_shape_transform**\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_body_get_shape_transform>`
  1439. Returns the transform matrix of a body shape.
  1440. .. rst-class:: classref-item-separator
  1441. ----
  1442. .. _class_PhysicsServer3D_method_body_get_space:
  1443. .. rst-class:: classref-method
  1444. :ref:`RID<class_RID>` **body_get_space**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_body_get_space>`
  1445. Returns the :ref:`RID<class_RID>` of the space assigned to a body.
  1446. .. rst-class:: classref-item-separator
  1447. ----
  1448. .. _class_PhysicsServer3D_method_body_get_state:
  1449. .. rst-class:: classref-method
  1450. :ref:`Variant<class_Variant>` **body_get_state**\ (\ body\: :ref:`RID<class_RID>`, state\: :ref:`BodyState<enum_PhysicsServer3D_BodyState>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_body_get_state>`
  1451. Returns a body state.
  1452. .. rst-class:: classref-item-separator
  1453. ----
  1454. .. _class_PhysicsServer3D_method_body_is_axis_locked:
  1455. .. rst-class:: classref-method
  1456. :ref:`bool<class_bool>` **body_is_axis_locked**\ (\ body\: :ref:`RID<class_RID>`, axis\: :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_body_is_axis_locked>`
  1457. .. container:: contribute
  1458. There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  1459. .. rst-class:: classref-item-separator
  1460. ----
  1461. .. _class_PhysicsServer3D_method_body_is_continuous_collision_detection_enabled:
  1462. .. rst-class:: classref-method
  1463. :ref:`bool<class_bool>` **body_is_continuous_collision_detection_enabled**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_body_is_continuous_collision_detection_enabled>`
  1464. If ``true``, the continuous collision detection mode is enabled.
  1465. .. rst-class:: classref-item-separator
  1466. ----
  1467. .. _class_PhysicsServer3D_method_body_is_omitting_force_integration:
  1468. .. rst-class:: classref-method
  1469. :ref:`bool<class_bool>` **body_is_omitting_force_integration**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_body_is_omitting_force_integration>`
  1470. Returns ``true`` if the body is omitting the standard force integration. See :ref:`body_set_omit_force_integration()<class_PhysicsServer3D_method_body_set_omit_force_integration>`.
  1471. .. rst-class:: classref-item-separator
  1472. ----
  1473. .. _class_PhysicsServer3D_method_body_remove_collision_exception:
  1474. .. rst-class:: classref-method
  1475. |void| **body_remove_collision_exception**\ (\ body\: :ref:`RID<class_RID>`, excepted_body\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_remove_collision_exception>`
  1476. Removes a body from the list of bodies exempt from collisions.
  1477. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
  1478. .. rst-class:: classref-item-separator
  1479. ----
  1480. .. _class_PhysicsServer3D_method_body_remove_shape:
  1481. .. rst-class:: classref-method
  1482. |void| **body_remove_shape**\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_remove_shape>`
  1483. Removes a shape from a body. The shape is not deleted, so it can be reused afterwards.
  1484. .. rst-class:: classref-item-separator
  1485. ----
  1486. .. _class_PhysicsServer3D_method_body_reset_mass_properties:
  1487. .. rst-class:: classref-method
  1488. |void| **body_reset_mass_properties**\ (\ body\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_reset_mass_properties>`
  1489. 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>`.
  1490. .. rst-class:: classref-item-separator
  1491. ----
  1492. .. _class_PhysicsServer3D_method_body_set_axis_lock:
  1493. .. rst-class:: classref-method
  1494. |void| **body_set_axis_lock**\ (\ body\: :ref:`RID<class_RID>`, axis\: :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>`, lock\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_set_axis_lock>`
  1495. .. container:: contribute
  1496. There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  1497. .. rst-class:: classref-item-separator
  1498. ----
  1499. .. _class_PhysicsServer3D_method_body_set_axis_velocity:
  1500. .. rst-class:: classref-method
  1501. |void| **body_set_axis_velocity**\ (\ body\: :ref:`RID<class_RID>`, axis_velocity\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_set_axis_velocity>`
  1502. 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.
  1503. .. rst-class:: classref-item-separator
  1504. ----
  1505. .. _class_PhysicsServer3D_method_body_set_collision_layer:
  1506. .. rst-class:: classref-method
  1507. |void| **body_set_collision_layer**\ (\ body\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_set_collision_layer>`
  1508. Sets the physics layer or layers a body belongs to.
  1509. .. rst-class:: classref-item-separator
  1510. ----
  1511. .. _class_PhysicsServer3D_method_body_set_collision_mask:
  1512. .. rst-class:: classref-method
  1513. |void| **body_set_collision_mask**\ (\ body\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_set_collision_mask>`
  1514. Sets the physics layer or layers a body can collide with.
  1515. .. rst-class:: classref-item-separator
  1516. ----
  1517. .. _class_PhysicsServer3D_method_body_set_collision_priority:
  1518. .. rst-class:: classref-method
  1519. |void| **body_set_collision_priority**\ (\ body\: :ref:`RID<class_RID>`, priority\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_set_collision_priority>`
  1520. Sets the body's collision priority.
  1521. .. rst-class:: classref-item-separator
  1522. ----
  1523. .. _class_PhysicsServer3D_method_body_set_constant_force:
  1524. .. rst-class:: classref-method
  1525. |void| **body_set_constant_force**\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_set_constant_force>`
  1526. Sets the body's total constant positional forces applied during each physics update.
  1527. 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>`.
  1528. .. rst-class:: classref-item-separator
  1529. ----
  1530. .. _class_PhysicsServer3D_method_body_set_constant_torque:
  1531. .. rst-class:: classref-method
  1532. |void| **body_set_constant_torque**\ (\ body\: :ref:`RID<class_RID>`, torque\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_set_constant_torque>`
  1533. Sets the body's total constant rotational forces applied during each physics update.
  1534. See :ref:`body_add_constant_torque()<class_PhysicsServer3D_method_body_add_constant_torque>`.
  1535. .. rst-class:: classref-item-separator
  1536. ----
  1537. .. _class_PhysicsServer3D_method_body_set_enable_continuous_collision_detection:
  1538. .. rst-class:: classref-method
  1539. |void| **body_set_enable_continuous_collision_detection**\ (\ body\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_set_enable_continuous_collision_detection>`
  1540. If ``true``, the continuous collision detection mode is enabled.
  1541. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
  1542. .. rst-class:: classref-item-separator
  1543. ----
  1544. .. _class_PhysicsServer3D_method_body_set_force_integration_callback:
  1545. .. rst-class:: classref-method
  1546. |void| **body_set_force_integration_callback**\ (\ body\: :ref:`RID<class_RID>`, callable\: :ref:`Callable<class_Callable>`, userdata\: :ref:`Variant<class_Variant>` = null\ ) :ref:`🔗<class_PhysicsServer3D_method_body_set_force_integration_callback>`
  1547. Sets the body's custom force integration callback function to ``callable``. Use an empty :ref:`Callable<class_Callable>` (``Callable()``) to clear the custom callback.
  1548. The function ``callable`` will be called every physics tick, before the standard force integration (see :ref:`body_set_omit_force_integration()<class_PhysicsServer3D_method_body_set_omit_force_integration>`). It can be used for example to update the body's linear and angular velocity based on contact with other bodies.
  1549. If ``userdata`` is not ``null``, the function ``callable`` must take the following two parameters:
  1550. 1. ``state``: a :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>`, used to retrieve and modify the body's state,
  1551. 2. ``userdata``: a :ref:`Variant<class_Variant>`; its value will be the ``userdata`` passed into this method.
  1552. If ``userdata`` is ``null``, then ``callable`` must take only the ``state`` parameter.
  1553. .. rst-class:: classref-item-separator
  1554. ----
  1555. .. _class_PhysicsServer3D_method_body_set_max_contacts_reported:
  1556. .. rst-class:: classref-method
  1557. |void| **body_set_max_contacts_reported**\ (\ body\: :ref:`RID<class_RID>`, amount\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_set_max_contacts_reported>`
  1558. 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.
  1559. .. rst-class:: classref-item-separator
  1560. ----
  1561. .. _class_PhysicsServer3D_method_body_set_mode:
  1562. .. rst-class:: classref-method
  1563. |void| **body_set_mode**\ (\ body\: :ref:`RID<class_RID>`, mode\: :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_set_mode>`
  1564. Sets the body mode.
  1565. .. rst-class:: classref-item-separator
  1566. ----
  1567. .. _class_PhysicsServer3D_method_body_set_omit_force_integration:
  1568. .. rst-class:: classref-method
  1569. |void| **body_set_omit_force_integration**\ (\ body\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_set_omit_force_integration>`
  1570. Sets whether the body omits the standard force integration. If ``enable`` is ``true``, the body will not automatically use applied forces, torques, and damping to update the body's linear and angular velocity. In this case, :ref:`body_set_force_integration_callback()<class_PhysicsServer3D_method_body_set_force_integration_callback>` can be used to manually update the linear and angular velocity instead.
  1571. This method is called when the property :ref:`RigidBody3D.custom_integrator<class_RigidBody3D_property_custom_integrator>` is set.
  1572. .. rst-class:: classref-item-separator
  1573. ----
  1574. .. _class_PhysicsServer3D_method_body_set_param:
  1575. .. rst-class:: classref-method
  1576. |void| **body_set_param**\ (\ body\: :ref:`RID<class_RID>`, param\: :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_set_param>`
  1577. Sets a body parameter. A list of available parameters is on the :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` constants.
  1578. .. rst-class:: classref-item-separator
  1579. ----
  1580. .. _class_PhysicsServer3D_method_body_set_ray_pickable:
  1581. .. rst-class:: classref-method
  1582. |void| **body_set_ray_pickable**\ (\ body\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_set_ray_pickable>`
  1583. Sets the body pickable with rays if ``enable`` is set.
  1584. .. rst-class:: classref-item-separator
  1585. ----
  1586. .. _class_PhysicsServer3D_method_body_set_shape:
  1587. .. rst-class:: classref-method
  1588. |void| **body_set_shape**\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, shape\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_set_shape>`
  1589. Substitutes a given body shape by another. The old shape is selected by its index, the new one by its :ref:`RID<class_RID>`.
  1590. .. rst-class:: classref-item-separator
  1591. ----
  1592. .. _class_PhysicsServer3D_method_body_set_shape_disabled:
  1593. .. rst-class:: classref-method
  1594. |void| **body_set_shape_disabled**\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_set_shape_disabled>`
  1595. .. container:: contribute
  1596. There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  1597. .. rst-class:: classref-item-separator
  1598. ----
  1599. .. _class_PhysicsServer3D_method_body_set_shape_transform:
  1600. .. rst-class:: classref-method
  1601. |void| **body_set_shape_transform**\ (\ body\: :ref:`RID<class_RID>`, shape_idx\: :ref:`int<class_int>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_set_shape_transform>`
  1602. Sets the transform matrix for a body shape.
  1603. .. rst-class:: classref-item-separator
  1604. ----
  1605. .. _class_PhysicsServer3D_method_body_set_space:
  1606. .. rst-class:: classref-method
  1607. |void| **body_set_space**\ (\ body\: :ref:`RID<class_RID>`, space\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_set_space>`
  1608. Assigns a space to the body (see :ref:`space_create()<class_PhysicsServer3D_method_space_create>`).
  1609. .. rst-class:: classref-item-separator
  1610. ----
  1611. .. _class_PhysicsServer3D_method_body_set_state:
  1612. .. rst-class:: classref-method
  1613. |void| **body_set_state**\ (\ body\: :ref:`RID<class_RID>`, state\: :ref:`BodyState<enum_PhysicsServer3D_BodyState>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_set_state>`
  1614. Sets a body state.
  1615. .. rst-class:: classref-item-separator
  1616. ----
  1617. .. _class_PhysicsServer3D_method_body_set_state_sync_callback:
  1618. .. rst-class:: classref-method
  1619. |void| **body_set_state_sync_callback**\ (\ body\: :ref:`RID<class_RID>`, callable\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_PhysicsServer3D_method_body_set_state_sync_callback>`
  1620. Sets the body's state synchronization callback function to ``callable``. Use an empty :ref:`Callable<class_Callable>` (``Callable()``) to clear the callback.
  1621. The function ``callable`` will be called every physics frame, assuming that the body was active during the previous physics tick, and can be used to fetch the latest state from the physics server.
  1622. The function ``callable`` must take the following parameters:
  1623. 1. ``state``: a :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>`, used to retrieve the body's state.
  1624. .. rst-class:: classref-item-separator
  1625. ----
  1626. .. _class_PhysicsServer3D_method_body_test_motion:
  1627. .. rst-class:: classref-method
  1628. :ref:`bool<class_bool>` **body_test_motion**\ (\ body\: :ref:`RID<class_RID>`, parameters\: :ref:`PhysicsTestMotionParameters3D<class_PhysicsTestMotionParameters3D>`, result\: :ref:`PhysicsTestMotionResult3D<class_PhysicsTestMotionResult3D>` = null\ ) :ref:`🔗<class_PhysicsServer3D_method_body_test_motion>`
  1629. 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.
  1630. .. rst-class:: classref-item-separator
  1631. ----
  1632. .. _class_PhysicsServer3D_method_box_shape_create:
  1633. .. rst-class:: classref-method
  1634. :ref:`RID<class_RID>` **box_shape_create**\ (\ ) :ref:`🔗<class_PhysicsServer3D_method_box_shape_create>`
  1635. Creates a 3D box shape in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. Use :ref:`shape_set_data()<class_PhysicsServer3D_method_shape_set_data>` to set the box's half-extents.
  1636. .. rst-class:: classref-item-separator
  1637. ----
  1638. .. _class_PhysicsServer3D_method_capsule_shape_create:
  1639. .. rst-class:: classref-method
  1640. :ref:`RID<class_RID>` **capsule_shape_create**\ (\ ) :ref:`🔗<class_PhysicsServer3D_method_capsule_shape_create>`
  1641. Creates a 3D capsule shape in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. Use :ref:`shape_set_data()<class_PhysicsServer3D_method_shape_set_data>` to set the capsule's height and radius.
  1642. .. rst-class:: classref-item-separator
  1643. ----
  1644. .. _class_PhysicsServer3D_method_concave_polygon_shape_create:
  1645. .. rst-class:: classref-method
  1646. :ref:`RID<class_RID>` **concave_polygon_shape_create**\ (\ ) :ref:`🔗<class_PhysicsServer3D_method_concave_polygon_shape_create>`
  1647. Creates a 3D concave polygon shape in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. Use :ref:`shape_set_data()<class_PhysicsServer3D_method_shape_set_data>` to set the concave polygon's triangles.
  1648. .. rst-class:: classref-item-separator
  1649. ----
  1650. .. _class_PhysicsServer3D_method_cone_twist_joint_get_param:
  1651. .. rst-class:: classref-method
  1652. :ref:`float<class_float>` **cone_twist_joint_get_param**\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_cone_twist_joint_get_param>`
  1653. Gets a cone twist joint parameter.
  1654. .. rst-class:: classref-item-separator
  1655. ----
  1656. .. _class_PhysicsServer3D_method_cone_twist_joint_set_param:
  1657. .. rst-class:: classref-method
  1658. |void| **cone_twist_joint_set_param**\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>`, value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PhysicsServer3D_method_cone_twist_joint_set_param>`
  1659. Sets a cone twist joint parameter.
  1660. .. rst-class:: classref-item-separator
  1661. ----
  1662. .. _class_PhysicsServer3D_method_convex_polygon_shape_create:
  1663. .. rst-class:: classref-method
  1664. :ref:`RID<class_RID>` **convex_polygon_shape_create**\ (\ ) :ref:`🔗<class_PhysicsServer3D_method_convex_polygon_shape_create>`
  1665. Creates a 3D convex polygon shape in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. Use :ref:`shape_set_data()<class_PhysicsServer3D_method_shape_set_data>` to set the convex polygon's points.
  1666. .. rst-class:: classref-item-separator
  1667. ----
  1668. .. _class_PhysicsServer3D_method_custom_shape_create:
  1669. .. rst-class:: classref-method
  1670. :ref:`RID<class_RID>` **custom_shape_create**\ (\ ) :ref:`🔗<class_PhysicsServer3D_method_custom_shape_create>`
  1671. Creates a custom shape in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. Use :ref:`shape_set_data()<class_PhysicsServer3D_method_shape_set_data>` to set the shape's data.
  1672. \ **Note:** Custom shapes are not supported by the built-in physics servers, so calling this method always produces an error when using Godot Physics or Jolt Physics. Custom physics servers implemented as GDExtensions may support a custom shape.
  1673. .. rst-class:: classref-item-separator
  1674. ----
  1675. .. _class_PhysicsServer3D_method_cylinder_shape_create:
  1676. .. rst-class:: classref-method
  1677. :ref:`RID<class_RID>` **cylinder_shape_create**\ (\ ) :ref:`🔗<class_PhysicsServer3D_method_cylinder_shape_create>`
  1678. Creates a 3D cylinder shape in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. Use :ref:`shape_set_data()<class_PhysicsServer3D_method_shape_set_data>` to set the cylinder's height and radius.
  1679. .. rst-class:: classref-item-separator
  1680. ----
  1681. .. _class_PhysicsServer3D_method_free_rid:
  1682. .. rst-class:: classref-method
  1683. |void| **free_rid**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_PhysicsServer3D_method_free_rid>`
  1684. 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.
  1685. .. rst-class:: classref-item-separator
  1686. ----
  1687. .. _class_PhysicsServer3D_method_generic_6dof_joint_get_flag:
  1688. .. rst-class:: classref-method
  1689. :ref:`bool<class_bool>` **generic_6dof_joint_get_flag**\ (\ joint\: :ref:`RID<class_RID>`, axis\: :ref:`Axis<enum_Vector3_Axis>`, flag\: :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_generic_6dof_joint_get_flag>`
  1690. Returns the value of a generic 6DOF joint flag.
  1691. .. rst-class:: classref-item-separator
  1692. ----
  1693. .. _class_PhysicsServer3D_method_generic_6dof_joint_get_param:
  1694. .. rst-class:: classref-method
  1695. :ref:`float<class_float>` **generic_6dof_joint_get_param**\ (\ joint\: :ref:`RID<class_RID>`, axis\: :ref:`Axis<enum_Vector3_Axis>`, param\: :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_generic_6dof_joint_get_param>`
  1696. Returns the value of a generic 6DOF joint parameter.
  1697. .. rst-class:: classref-item-separator
  1698. ----
  1699. .. _class_PhysicsServer3D_method_generic_6dof_joint_set_flag:
  1700. .. rst-class:: classref-method
  1701. |void| **generic_6dof_joint_set_flag**\ (\ joint\: :ref:`RID<class_RID>`, axis\: :ref:`Axis<enum_Vector3_Axis>`, flag\: :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_PhysicsServer3D_method_generic_6dof_joint_set_flag>`
  1702. Sets the value of a given generic 6DOF joint flag.
  1703. .. rst-class:: classref-item-separator
  1704. ----
  1705. .. _class_PhysicsServer3D_method_generic_6dof_joint_set_param:
  1706. .. rst-class:: classref-method
  1707. |void| **generic_6dof_joint_set_param**\ (\ joint\: :ref:`RID<class_RID>`, axis\: :ref:`Axis<enum_Vector3_Axis>`, param\: :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>`, value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PhysicsServer3D_method_generic_6dof_joint_set_param>`
  1708. Sets the value of a given generic 6DOF joint parameter.
  1709. .. rst-class:: classref-item-separator
  1710. ----
  1711. .. _class_PhysicsServer3D_method_get_process_info:
  1712. .. rst-class:: classref-method
  1713. :ref:`int<class_int>` **get_process_info**\ (\ process_info\: :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>`\ ) :ref:`🔗<class_PhysicsServer3D_method_get_process_info>`
  1714. Returns the value of a physics engine state specified by ``process_info``.
  1715. .. rst-class:: classref-item-separator
  1716. ----
  1717. .. _class_PhysicsServer3D_method_heightmap_shape_create:
  1718. .. rst-class:: classref-method
  1719. :ref:`RID<class_RID>` **heightmap_shape_create**\ (\ ) :ref:`🔗<class_PhysicsServer3D_method_heightmap_shape_create>`
  1720. Creates a 3D heightmap shape in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. Use :ref:`shape_set_data()<class_PhysicsServer3D_method_shape_set_data>` to set the heightmap's data.
  1721. .. rst-class:: classref-item-separator
  1722. ----
  1723. .. _class_PhysicsServer3D_method_hinge_joint_get_flag:
  1724. .. rst-class:: classref-method
  1725. :ref:`bool<class_bool>` **hinge_joint_get_flag**\ (\ joint\: :ref:`RID<class_RID>`, flag\: :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_hinge_joint_get_flag>`
  1726. Gets a hinge joint flag.
  1727. .. rst-class:: classref-item-separator
  1728. ----
  1729. .. _class_PhysicsServer3D_method_hinge_joint_get_param:
  1730. .. rst-class:: classref-method
  1731. :ref:`float<class_float>` **hinge_joint_get_param**\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_hinge_joint_get_param>`
  1732. Gets a hinge joint parameter.
  1733. .. rst-class:: classref-item-separator
  1734. ----
  1735. .. _class_PhysicsServer3D_method_hinge_joint_set_flag:
  1736. .. rst-class:: classref-method
  1737. |void| **hinge_joint_set_flag**\ (\ joint\: :ref:`RID<class_RID>`, flag\: :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_PhysicsServer3D_method_hinge_joint_set_flag>`
  1738. Sets a hinge joint flag.
  1739. .. rst-class:: classref-item-separator
  1740. ----
  1741. .. _class_PhysicsServer3D_method_hinge_joint_set_param:
  1742. .. rst-class:: classref-method
  1743. |void| **hinge_joint_set_param**\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>`, value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PhysicsServer3D_method_hinge_joint_set_param>`
  1744. Sets a hinge joint parameter.
  1745. .. rst-class:: classref-item-separator
  1746. ----
  1747. .. _class_PhysicsServer3D_method_joint_clear:
  1748. .. rst-class:: classref-method
  1749. |void| **joint_clear**\ (\ joint\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_PhysicsServer3D_method_joint_clear>`
  1750. .. container:: contribute
  1751. There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  1752. .. rst-class:: classref-item-separator
  1753. ----
  1754. .. _class_PhysicsServer3D_method_joint_create:
  1755. .. rst-class:: classref-method
  1756. :ref:`RID<class_RID>` **joint_create**\ (\ ) :ref:`🔗<class_PhysicsServer3D_method_joint_create>`
  1757. .. container:: contribute
  1758. There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  1759. .. rst-class:: classref-item-separator
  1760. ----
  1761. .. _class_PhysicsServer3D_method_joint_disable_collisions_between_bodies:
  1762. .. rst-class:: classref-method
  1763. |void| **joint_disable_collisions_between_bodies**\ (\ joint\: :ref:`RID<class_RID>`, disable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_PhysicsServer3D_method_joint_disable_collisions_between_bodies>`
  1764. Sets whether the bodies attached to the :ref:`Joint3D<class_Joint3D>` will collide with each other.
  1765. .. rst-class:: classref-item-separator
  1766. ----
  1767. .. _class_PhysicsServer3D_method_joint_get_solver_priority:
  1768. .. rst-class:: classref-method
  1769. :ref:`int<class_int>` **joint_get_solver_priority**\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_joint_get_solver_priority>`
  1770. Gets the priority value of the Joint3D.
  1771. .. rst-class:: classref-item-separator
  1772. ----
  1773. .. _class_PhysicsServer3D_method_joint_get_type:
  1774. .. rst-class:: classref-method
  1775. :ref:`JointType<enum_PhysicsServer3D_JointType>` **joint_get_type**\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_joint_get_type>`
  1776. Returns the type of the Joint3D.
  1777. .. rst-class:: classref-item-separator
  1778. ----
  1779. .. _class_PhysicsServer3D_method_joint_is_disabled_collisions_between_bodies:
  1780. .. rst-class:: classref-method
  1781. :ref:`bool<class_bool>` **joint_is_disabled_collisions_between_bodies**\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_joint_is_disabled_collisions_between_bodies>`
  1782. Returns whether the bodies attached to the :ref:`Joint3D<class_Joint3D>` will collide with each other.
  1783. .. rst-class:: classref-item-separator
  1784. ----
  1785. .. _class_PhysicsServer3D_method_joint_make_cone_twist:
  1786. .. rst-class:: classref-method
  1787. |void| **joint_make_cone_twist**\ (\ joint\: :ref:`RID<class_RID>`, body_A\: :ref:`RID<class_RID>`, local_ref_A\: :ref:`Transform3D<class_Transform3D>`, body_B\: :ref:`RID<class_RID>`, local_ref_B\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`🔗<class_PhysicsServer3D_method_joint_make_cone_twist>`
  1788. .. container:: contribute
  1789. There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  1790. .. rst-class:: classref-item-separator
  1791. ----
  1792. .. _class_PhysicsServer3D_method_joint_make_generic_6dof:
  1793. .. rst-class:: classref-method
  1794. |void| **joint_make_generic_6dof**\ (\ joint\: :ref:`RID<class_RID>`, body_A\: :ref:`RID<class_RID>`, local_ref_A\: :ref:`Transform3D<class_Transform3D>`, body_B\: :ref:`RID<class_RID>`, local_ref_B\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`🔗<class_PhysicsServer3D_method_joint_make_generic_6dof>`
  1795. Make the joint a generic six degrees of freedom (6DOF) joint. Use :ref:`generic_6dof_joint_set_flag()<class_PhysicsServer3D_method_generic_6dof_joint_set_flag>` and :ref:`generic_6dof_joint_set_param()<class_PhysicsServer3D_method_generic_6dof_joint_set_param>` to set the joint's flags and parameters respectively.
  1796. .. rst-class:: classref-item-separator
  1797. ----
  1798. .. _class_PhysicsServer3D_method_joint_make_hinge:
  1799. .. rst-class:: classref-method
  1800. |void| **joint_make_hinge**\ (\ joint\: :ref:`RID<class_RID>`, body_A\: :ref:`RID<class_RID>`, hinge_A\: :ref:`Transform3D<class_Transform3D>`, body_B\: :ref:`RID<class_RID>`, hinge_B\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`🔗<class_PhysicsServer3D_method_joint_make_hinge>`
  1801. .. container:: contribute
  1802. There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  1803. .. rst-class:: classref-item-separator
  1804. ----
  1805. .. _class_PhysicsServer3D_method_joint_make_pin:
  1806. .. rst-class:: classref-method
  1807. |void| **joint_make_pin**\ (\ joint\: :ref:`RID<class_RID>`, body_A\: :ref:`RID<class_RID>`, local_A\: :ref:`Vector3<class_Vector3>`, body_B\: :ref:`RID<class_RID>`, local_B\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsServer3D_method_joint_make_pin>`
  1808. .. container:: contribute
  1809. There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  1810. .. rst-class:: classref-item-separator
  1811. ----
  1812. .. _class_PhysicsServer3D_method_joint_make_slider:
  1813. .. rst-class:: classref-method
  1814. |void| **joint_make_slider**\ (\ joint\: :ref:`RID<class_RID>`, body_A\: :ref:`RID<class_RID>`, local_ref_A\: :ref:`Transform3D<class_Transform3D>`, body_B\: :ref:`RID<class_RID>`, local_ref_B\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`🔗<class_PhysicsServer3D_method_joint_make_slider>`
  1815. .. container:: contribute
  1816. There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
  1817. .. rst-class:: classref-item-separator
  1818. ----
  1819. .. _class_PhysicsServer3D_method_joint_set_solver_priority:
  1820. .. rst-class:: classref-method
  1821. |void| **joint_set_solver_priority**\ (\ joint\: :ref:`RID<class_RID>`, priority\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PhysicsServer3D_method_joint_set_solver_priority>`
  1822. Sets the priority value of the Joint3D.
  1823. .. rst-class:: classref-item-separator
  1824. ----
  1825. .. _class_PhysicsServer3D_method_pin_joint_get_local_a:
  1826. .. rst-class:: classref-method
  1827. :ref:`Vector3<class_Vector3>` **pin_joint_get_local_a**\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_pin_joint_get_local_a>`
  1828. Returns position of the joint in the local space of body a of the joint.
  1829. .. rst-class:: classref-item-separator
  1830. ----
  1831. .. _class_PhysicsServer3D_method_pin_joint_get_local_b:
  1832. .. rst-class:: classref-method
  1833. :ref:`Vector3<class_Vector3>` **pin_joint_get_local_b**\ (\ joint\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_pin_joint_get_local_b>`
  1834. Returns position of the joint in the local space of body b of the joint.
  1835. .. rst-class:: classref-item-separator
  1836. ----
  1837. .. _class_PhysicsServer3D_method_pin_joint_get_param:
  1838. .. rst-class:: classref-method
  1839. :ref:`float<class_float>` **pin_joint_get_param**\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_pin_joint_get_param>`
  1840. Gets a pin joint parameter.
  1841. .. rst-class:: classref-item-separator
  1842. ----
  1843. .. _class_PhysicsServer3D_method_pin_joint_set_local_a:
  1844. .. rst-class:: classref-method
  1845. |void| **pin_joint_set_local_a**\ (\ joint\: :ref:`RID<class_RID>`, local_A\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsServer3D_method_pin_joint_set_local_a>`
  1846. Sets position of the joint in the local space of body a of the joint.
  1847. .. rst-class:: classref-item-separator
  1848. ----
  1849. .. _class_PhysicsServer3D_method_pin_joint_set_local_b:
  1850. .. rst-class:: classref-method
  1851. |void| **pin_joint_set_local_b**\ (\ joint\: :ref:`RID<class_RID>`, local_B\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsServer3D_method_pin_joint_set_local_b>`
  1852. Sets position of the joint in the local space of body b of the joint.
  1853. .. rst-class:: classref-item-separator
  1854. ----
  1855. .. _class_PhysicsServer3D_method_pin_joint_set_param:
  1856. .. rst-class:: classref-method
  1857. |void| **pin_joint_set_param**\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>`, value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PhysicsServer3D_method_pin_joint_set_param>`
  1858. Sets a pin joint parameter.
  1859. .. rst-class:: classref-item-separator
  1860. ----
  1861. .. _class_PhysicsServer3D_method_separation_ray_shape_create:
  1862. .. rst-class:: classref-method
  1863. :ref:`RID<class_RID>` **separation_ray_shape_create**\ (\ ) :ref:`🔗<class_PhysicsServer3D_method_separation_ray_shape_create>`
  1864. Creates a 3D separation ray shape in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. Use :ref:`shape_set_data()<class_PhysicsServer3D_method_shape_set_data>` to set the shape's ``length`` and ``slide_on_slope`` properties.
  1865. .. rst-class:: classref-item-separator
  1866. ----
  1867. .. _class_PhysicsServer3D_method_set_active:
  1868. .. rst-class:: classref-method
  1869. |void| **set_active**\ (\ active\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_PhysicsServer3D_method_set_active>`
  1870. Activates or deactivates the 3D physics engine.
  1871. .. rst-class:: classref-item-separator
  1872. ----
  1873. .. _class_PhysicsServer3D_method_shape_get_data:
  1874. .. rst-class:: classref-method
  1875. :ref:`Variant<class_Variant>` **shape_get_data**\ (\ shape\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_shape_get_data>`
  1876. Returns the shape data that configures the shape, such as the half-extents of a box or the triangles of a concave (trimesh) shape. See :ref:`shape_set_data()<class_PhysicsServer3D_method_shape_set_data>` for the precise format of this data in each case.
  1877. .. rst-class:: classref-item-separator
  1878. ----
  1879. .. _class_PhysicsServer3D_method_shape_get_margin:
  1880. .. rst-class:: classref-method
  1881. :ref:`float<class_float>` **shape_get_margin**\ (\ shape\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_shape_get_margin>`
  1882. Returns the collision margin for the shape.
  1883. \ **Note:** This is not used in Godot Physics, so will always return ``0``.
  1884. .. rst-class:: classref-item-separator
  1885. ----
  1886. .. _class_PhysicsServer3D_method_shape_get_type:
  1887. .. rst-class:: classref-method
  1888. :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **shape_get_type**\ (\ shape\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_shape_get_type>`
  1889. Returns the shape's type.
  1890. .. rst-class:: classref-item-separator
  1891. ----
  1892. .. _class_PhysicsServer3D_method_shape_set_data:
  1893. .. rst-class:: classref-method
  1894. |void| **shape_set_data**\ (\ shape\: :ref:`RID<class_RID>`, data\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_PhysicsServer3D_method_shape_set_data>`
  1895. Sets the shape data that configures the shape. The ``data`` to be passed depends on the shape's type (see :ref:`shape_get_type()<class_PhysicsServer3D_method_shape_get_type>`):
  1896. - :ref:`SHAPE_WORLD_BOUNDARY<class_PhysicsServer3D_constant_SHAPE_WORLD_BOUNDARY>`: a :ref:`Plane<class_Plane>`,
  1897. - :ref:`SHAPE_SEPARATION_RAY<class_PhysicsServer3D_constant_SHAPE_SEPARATION_RAY>`: a dictionary containing the key ``"length"`` with a :ref:`float<class_float>` value and the key ``"slide_on_slope"`` with a :ref:`bool<class_bool>` value,
  1898. - :ref:`SHAPE_SPHERE<class_PhysicsServer3D_constant_SHAPE_SPHERE>`: a :ref:`float<class_float>` that is the radius of the sphere,
  1899. - :ref:`SHAPE_BOX<class_PhysicsServer3D_constant_SHAPE_BOX>`: a :ref:`Vector3<class_Vector3>` containing the half-extents of the box,
  1900. - :ref:`SHAPE_CAPSULE<class_PhysicsServer3D_constant_SHAPE_CAPSULE>`: a dictionary containing the keys ``"height"`` and ``"radius"`` with :ref:`float<class_float>` values,
  1901. - :ref:`SHAPE_CYLINDER<class_PhysicsServer3D_constant_SHAPE_CYLINDER>`: a dictionary containing the keys ``"height"`` and ``"radius"`` with :ref:`float<class_float>` values,
  1902. - :ref:`SHAPE_CONVEX_POLYGON<class_PhysicsServer3D_constant_SHAPE_CONVEX_POLYGON>`: a :ref:`PackedVector3Array<class_PackedVector3Array>` of points defining a convex polygon (the shape will be the convex hull of the points),
  1903. - :ref:`SHAPE_CONCAVE_POLYGON<class_PhysicsServer3D_constant_SHAPE_CONCAVE_POLYGON>`: a dictionary containing the key ``"faces"`` with a :ref:`PackedVector3Array<class_PackedVector3Array>` value (with a length divisible by 3, so that each 3-tuple of points forms a face) and the key ``"backface_collision"`` with a :ref:`bool<class_bool>` value,
  1904. - :ref:`SHAPE_HEIGHTMAP<class_PhysicsServer3D_constant_SHAPE_HEIGHTMAP>`: a dictionary containing the keys ``"width"`` and ``"depth"`` with :ref:`int<class_int>` values, and the key ``"heights"`` with a value that is a packed array of :ref:`float<class_float>`\ s of length ``width * depth`` (that is a :ref:`PackedFloat32Array<class_PackedFloat32Array>`, or a :ref:`PackedFloat64Array<class_PackedFloat64Array>` if Godot was compiled with the ``precision=double`` option), and optionally the keys ``"min_height"`` and ``"max_height"`` with :ref:`float<class_float>` values,
  1905. - :ref:`SHAPE_SOFT_BODY<class_PhysicsServer3D_constant_SHAPE_SOFT_BODY>`: the input ``data`` is ignored and this method has no effect,
  1906. - :ref:`SHAPE_CUSTOM<class_PhysicsServer3D_constant_SHAPE_CUSTOM>`: the input ``data`` is interpreted by a custom physics server, if it supports custom shapes.
  1907. .. rst-class:: classref-item-separator
  1908. ----
  1909. .. _class_PhysicsServer3D_method_shape_set_margin:
  1910. .. rst-class:: classref-method
  1911. |void| **shape_set_margin**\ (\ shape\: :ref:`RID<class_RID>`, margin\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PhysicsServer3D_method_shape_set_margin>`
  1912. Sets the collision margin for the shape.
  1913. \ **Note:** This is not used in Godot Physics.
  1914. .. rst-class:: classref-item-separator
  1915. ----
  1916. .. _class_PhysicsServer3D_method_slider_joint_get_param:
  1917. .. rst-class:: classref-method
  1918. :ref:`float<class_float>` **slider_joint_get_param**\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_slider_joint_get_param>`
  1919. Gets a slider joint parameter.
  1920. .. rst-class:: classref-item-separator
  1921. ----
  1922. .. _class_PhysicsServer3D_method_slider_joint_set_param:
  1923. .. rst-class:: classref-method
  1924. |void| **slider_joint_set_param**\ (\ joint\: :ref:`RID<class_RID>`, param\: :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>`, value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PhysicsServer3D_method_slider_joint_set_param>`
  1925. Gets a slider joint parameter.
  1926. .. rst-class:: classref-item-separator
  1927. ----
  1928. .. _class_PhysicsServer3D_method_soft_body_add_collision_exception:
  1929. .. rst-class:: classref-method
  1930. |void| **soft_body_add_collision_exception**\ (\ body\: :ref:`RID<class_RID>`, body_b\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_add_collision_exception>`
  1931. Adds the given body to the list of bodies exempt from collisions.
  1932. .. rst-class:: classref-item-separator
  1933. ----
  1934. .. _class_PhysicsServer3D_method_soft_body_apply_central_force:
  1935. .. rst-class:: classref-method
  1936. |void| **soft_body_apply_central_force**\ (\ body\: :ref:`RID<class_RID>`, force\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_apply_central_force>`
  1937. Distributes and applies a force to all points. A force is time dependent and meant to be applied every physics update.
  1938. .. rst-class:: classref-item-separator
  1939. ----
  1940. .. _class_PhysicsServer3D_method_soft_body_apply_central_impulse:
  1941. .. rst-class:: classref-method
  1942. |void| **soft_body_apply_central_impulse**\ (\ body\: :ref:`RID<class_RID>`, impulse\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_apply_central_impulse>`
  1943. Distributes and applies an impulse to all points.
  1944. 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).
  1945. .. rst-class:: classref-item-separator
  1946. ----
  1947. .. _class_PhysicsServer3D_method_soft_body_apply_point_force:
  1948. .. rst-class:: classref-method
  1949. |void| **soft_body_apply_point_force**\ (\ body\: :ref:`RID<class_RID>`, point_index\: :ref:`int<class_int>`, force\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_apply_point_force>`
  1950. Applies a force to a point. A force is time dependent and meant to be applied every physics update.
  1951. .. rst-class:: classref-item-separator
  1952. ----
  1953. .. _class_PhysicsServer3D_method_soft_body_apply_point_impulse:
  1954. .. rst-class:: classref-method
  1955. |void| **soft_body_apply_point_impulse**\ (\ body\: :ref:`RID<class_RID>`, point_index\: :ref:`int<class_int>`, impulse\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_apply_point_impulse>`
  1956. Applies an impulse to a point.
  1957. 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).
  1958. .. rst-class:: classref-item-separator
  1959. ----
  1960. .. _class_PhysicsServer3D_method_soft_body_create:
  1961. .. rst-class:: classref-method
  1962. :ref:`RID<class_RID>` **soft_body_create**\ (\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_create>`
  1963. Creates a new soft body and returns its internal :ref:`RID<class_RID>`.
  1964. .. rst-class:: classref-item-separator
  1965. ----
  1966. .. _class_PhysicsServer3D_method_soft_body_get_bounds:
  1967. .. rst-class:: classref-method
  1968. :ref:`AABB<class_AABB>` **soft_body_get_bounds**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_soft_body_get_bounds>`
  1969. Returns the bounds of the given soft body in global coordinates.
  1970. .. rst-class:: classref-item-separator
  1971. ----
  1972. .. _class_PhysicsServer3D_method_soft_body_get_collision_layer:
  1973. .. rst-class:: classref-method
  1974. :ref:`int<class_int>` **soft_body_get_collision_layer**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_soft_body_get_collision_layer>`
  1975. Returns the physics layer or layers that the given soft body belongs to.
  1976. .. rst-class:: classref-item-separator
  1977. ----
  1978. .. _class_PhysicsServer3D_method_soft_body_get_collision_mask:
  1979. .. rst-class:: classref-method
  1980. :ref:`int<class_int>` **soft_body_get_collision_mask**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_soft_body_get_collision_mask>`
  1981. Returns the physics layer or layers that the given soft body can collide with.
  1982. .. rst-class:: classref-item-separator
  1983. ----
  1984. .. _class_PhysicsServer3D_method_soft_body_get_damping_coefficient:
  1985. .. rst-class:: classref-method
  1986. :ref:`float<class_float>` **soft_body_get_damping_coefficient**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_soft_body_get_damping_coefficient>`
  1987. Returns the damping coefficient of the given soft body.
  1988. .. rst-class:: classref-item-separator
  1989. ----
  1990. .. _class_PhysicsServer3D_method_soft_body_get_drag_coefficient:
  1991. .. rst-class:: classref-method
  1992. :ref:`float<class_float>` **soft_body_get_drag_coefficient**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_soft_body_get_drag_coefficient>`
  1993. Returns the drag coefficient of the given soft body.
  1994. .. rst-class:: classref-item-separator
  1995. ----
  1996. .. _class_PhysicsServer3D_method_soft_body_get_linear_stiffness:
  1997. .. rst-class:: classref-method
  1998. :ref:`float<class_float>` **soft_body_get_linear_stiffness**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_soft_body_get_linear_stiffness>`
  1999. Returns the linear stiffness of the given soft body.
  2000. .. rst-class:: classref-item-separator
  2001. ----
  2002. .. _class_PhysicsServer3D_method_soft_body_get_point_global_position:
  2003. .. rst-class:: classref-method
  2004. :ref:`Vector3<class_Vector3>` **soft_body_get_point_global_position**\ (\ body\: :ref:`RID<class_RID>`, point_index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_soft_body_get_point_global_position>`
  2005. Returns the current position of the given soft body point in global coordinates.
  2006. .. rst-class:: classref-item-separator
  2007. ----
  2008. .. _class_PhysicsServer3D_method_soft_body_get_pressure_coefficient:
  2009. .. rst-class:: classref-method
  2010. :ref:`float<class_float>` **soft_body_get_pressure_coefficient**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_soft_body_get_pressure_coefficient>`
  2011. Returns the pressure coefficient of the given soft body.
  2012. .. rst-class:: classref-item-separator
  2013. ----
  2014. .. _class_PhysicsServer3D_method_soft_body_get_shrinking_factor:
  2015. .. rst-class:: classref-method
  2016. :ref:`float<class_float>` **soft_body_get_shrinking_factor**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_soft_body_get_shrinking_factor>`
  2017. Returns the shrinking factor of the given soft body.
  2018. .. rst-class:: classref-item-separator
  2019. ----
  2020. .. _class_PhysicsServer3D_method_soft_body_get_simulation_precision:
  2021. .. rst-class:: classref-method
  2022. :ref:`int<class_int>` **soft_body_get_simulation_precision**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_soft_body_get_simulation_precision>`
  2023. Returns the simulation precision of the given soft body.
  2024. .. rst-class:: classref-item-separator
  2025. ----
  2026. .. _class_PhysicsServer3D_method_soft_body_get_space:
  2027. .. rst-class:: classref-method
  2028. :ref:`RID<class_RID>` **soft_body_get_space**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_soft_body_get_space>`
  2029. Returns the :ref:`RID<class_RID>` of the space assigned to the given soft body.
  2030. .. rst-class:: classref-item-separator
  2031. ----
  2032. .. _class_PhysicsServer3D_method_soft_body_get_state:
  2033. .. rst-class:: classref-method
  2034. :ref:`Variant<class_Variant>` **soft_body_get_state**\ (\ body\: :ref:`RID<class_RID>`, state\: :ref:`BodyState<enum_PhysicsServer3D_BodyState>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_soft_body_get_state>`
  2035. Returns the given soft body state.
  2036. \ **Note:** Godot's default physics implementation does not support :ref:`BODY_STATE_LINEAR_VELOCITY<class_PhysicsServer3D_constant_BODY_STATE_LINEAR_VELOCITY>`, :ref:`BODY_STATE_ANGULAR_VELOCITY<class_PhysicsServer3D_constant_BODY_STATE_ANGULAR_VELOCITY>`, :ref:`BODY_STATE_SLEEPING<class_PhysicsServer3D_constant_BODY_STATE_SLEEPING>`, or :ref:`BODY_STATE_CAN_SLEEP<class_PhysicsServer3D_constant_BODY_STATE_CAN_SLEEP>`.
  2037. .. rst-class:: classref-item-separator
  2038. ----
  2039. .. _class_PhysicsServer3D_method_soft_body_get_total_mass:
  2040. .. rst-class:: classref-method
  2041. :ref:`float<class_float>` **soft_body_get_total_mass**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_soft_body_get_total_mass>`
  2042. Returns the total mass assigned to the given soft body.
  2043. .. rst-class:: classref-item-separator
  2044. ----
  2045. .. _class_PhysicsServer3D_method_soft_body_is_point_pinned:
  2046. .. rst-class:: classref-method
  2047. :ref:`bool<class_bool>` **soft_body_is_point_pinned**\ (\ body\: :ref:`RID<class_RID>`, point_index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_soft_body_is_point_pinned>`
  2048. Returns whether the given soft body point is pinned.
  2049. .. rst-class:: classref-item-separator
  2050. ----
  2051. .. _class_PhysicsServer3D_method_soft_body_move_point:
  2052. .. rst-class:: classref-method
  2053. |void| **soft_body_move_point**\ (\ body\: :ref:`RID<class_RID>`, point_index\: :ref:`int<class_int>`, global_position\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_move_point>`
  2054. Moves the given soft body point to a position in global coordinates.
  2055. .. rst-class:: classref-item-separator
  2056. ----
  2057. .. _class_PhysicsServer3D_method_soft_body_pin_point:
  2058. .. rst-class:: classref-method
  2059. |void| **soft_body_pin_point**\ (\ body\: :ref:`RID<class_RID>`, point_index\: :ref:`int<class_int>`, pin\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_pin_point>`
  2060. Pins or unpins the given soft body point based on the value of ``pin``.
  2061. \ **Note:** Pinning a point effectively makes it kinematic, preventing it from being affected by forces, but you can still move it using :ref:`soft_body_move_point()<class_PhysicsServer3D_method_soft_body_move_point>`.
  2062. .. rst-class:: classref-item-separator
  2063. ----
  2064. .. _class_PhysicsServer3D_method_soft_body_remove_all_pinned_points:
  2065. .. rst-class:: classref-method
  2066. |void| **soft_body_remove_all_pinned_points**\ (\ body\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_remove_all_pinned_points>`
  2067. Unpins all points of the given soft body.
  2068. .. rst-class:: classref-item-separator
  2069. ----
  2070. .. _class_PhysicsServer3D_method_soft_body_remove_collision_exception:
  2071. .. rst-class:: classref-method
  2072. |void| **soft_body_remove_collision_exception**\ (\ body\: :ref:`RID<class_RID>`, body_b\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_remove_collision_exception>`
  2073. Removes the given body from the list of bodies exempt from collisions.
  2074. .. rst-class:: classref-item-separator
  2075. ----
  2076. .. _class_PhysicsServer3D_method_soft_body_set_collision_layer:
  2077. .. rst-class:: classref-method
  2078. |void| **soft_body_set_collision_layer**\ (\ body\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_set_collision_layer>`
  2079. Sets the physics layer or layers the given soft body belongs to.
  2080. .. rst-class:: classref-item-separator
  2081. ----
  2082. .. _class_PhysicsServer3D_method_soft_body_set_collision_mask:
  2083. .. rst-class:: classref-method
  2084. |void| **soft_body_set_collision_mask**\ (\ body\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_set_collision_mask>`
  2085. Sets the physics layer or layers the given soft body can collide with.
  2086. .. rst-class:: classref-item-separator
  2087. ----
  2088. .. _class_PhysicsServer3D_method_soft_body_set_damping_coefficient:
  2089. .. rst-class:: classref-method
  2090. |void| **soft_body_set_damping_coefficient**\ (\ body\: :ref:`RID<class_RID>`, damping_coefficient\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_set_damping_coefficient>`
  2091. Sets the damping coefficient of the given soft body. Higher values will slow down the body more noticeably when forces are applied.
  2092. .. rst-class:: classref-item-separator
  2093. ----
  2094. .. _class_PhysicsServer3D_method_soft_body_set_drag_coefficient:
  2095. .. rst-class:: classref-method
  2096. |void| **soft_body_set_drag_coefficient**\ (\ body\: :ref:`RID<class_RID>`, drag_coefficient\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_set_drag_coefficient>`
  2097. Sets the drag coefficient of the given soft body. Higher values increase this body's air resistance.
  2098. \ **Note:** This value is currently unused by Godot's default physics implementation.
  2099. .. rst-class:: classref-item-separator
  2100. ----
  2101. .. _class_PhysicsServer3D_method_soft_body_set_linear_stiffness:
  2102. .. rst-class:: classref-method
  2103. |void| **soft_body_set_linear_stiffness**\ (\ body\: :ref:`RID<class_RID>`, stiffness\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_set_linear_stiffness>`
  2104. Sets the linear stiffness of the given soft body. Higher values will result in a stiffer body, while lower values will increase the body's ability to bend. The value can be between ``0.0`` and ``1.0`` (inclusive).
  2105. .. rst-class:: classref-item-separator
  2106. ----
  2107. .. _class_PhysicsServer3D_method_soft_body_set_mesh:
  2108. .. rst-class:: classref-method
  2109. |void| **soft_body_set_mesh**\ (\ body\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_set_mesh>`
  2110. Sets the mesh of the given soft body.
  2111. .. rst-class:: classref-item-separator
  2112. ----
  2113. .. _class_PhysicsServer3D_method_soft_body_set_pressure_coefficient:
  2114. .. rst-class:: classref-method
  2115. |void| **soft_body_set_pressure_coefficient**\ (\ body\: :ref:`RID<class_RID>`, pressure_coefficient\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_set_pressure_coefficient>`
  2116. Sets the pressure coefficient of the given soft body. Simulates pressure build-up from inside this body. Higher values increase the strength of this effect.
  2117. .. rst-class:: classref-item-separator
  2118. ----
  2119. .. _class_PhysicsServer3D_method_soft_body_set_ray_pickable:
  2120. .. rst-class:: classref-method
  2121. |void| **soft_body_set_ray_pickable**\ (\ body\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_set_ray_pickable>`
  2122. Sets whether the given soft body will be pickable when using object picking.
  2123. .. rst-class:: classref-item-separator
  2124. ----
  2125. .. _class_PhysicsServer3D_method_soft_body_set_shrinking_factor:
  2126. .. rst-class:: classref-method
  2127. |void| **soft_body_set_shrinking_factor**\ (\ body\: :ref:`RID<class_RID>`, shrinking_factor\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_set_shrinking_factor>`
  2128. Sets the shrinking factor of the given soft body.
  2129. .. rst-class:: classref-item-separator
  2130. ----
  2131. .. _class_PhysicsServer3D_method_soft_body_set_simulation_precision:
  2132. .. rst-class:: classref-method
  2133. |void| **soft_body_set_simulation_precision**\ (\ body\: :ref:`RID<class_RID>`, simulation_precision\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_set_simulation_precision>`
  2134. Sets the simulation precision of the given soft body. Increasing this value will improve the resulting simulation, but can affect performance. Use with care.
  2135. .. rst-class:: classref-item-separator
  2136. ----
  2137. .. _class_PhysicsServer3D_method_soft_body_set_space:
  2138. .. rst-class:: classref-method
  2139. |void| **soft_body_set_space**\ (\ body\: :ref:`RID<class_RID>`, space\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_set_space>`
  2140. Assigns a space to the given soft body (see :ref:`space_create()<class_PhysicsServer3D_method_space_create>`).
  2141. .. rst-class:: classref-item-separator
  2142. ----
  2143. .. _class_PhysicsServer3D_method_soft_body_set_state:
  2144. .. rst-class:: classref-method
  2145. |void| **soft_body_set_state**\ (\ body\: :ref:`RID<class_RID>`, state\: :ref:`BodyState<enum_PhysicsServer3D_BodyState>`, variant\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_set_state>`
  2146. Sets the given body state for the given body.
  2147. \ **Note:** Godot's default physics implementation does not support :ref:`BODY_STATE_LINEAR_VELOCITY<class_PhysicsServer3D_constant_BODY_STATE_LINEAR_VELOCITY>`, :ref:`BODY_STATE_ANGULAR_VELOCITY<class_PhysicsServer3D_constant_BODY_STATE_ANGULAR_VELOCITY>`, :ref:`BODY_STATE_SLEEPING<class_PhysicsServer3D_constant_BODY_STATE_SLEEPING>`, or :ref:`BODY_STATE_CAN_SLEEP<class_PhysicsServer3D_constant_BODY_STATE_CAN_SLEEP>`.
  2148. .. rst-class:: classref-item-separator
  2149. ----
  2150. .. _class_PhysicsServer3D_method_soft_body_set_total_mass:
  2151. .. rst-class:: classref-method
  2152. |void| **soft_body_set_total_mass**\ (\ body\: :ref:`RID<class_RID>`, total_mass\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_set_total_mass>`
  2153. Sets the total mass for the given soft body.
  2154. .. rst-class:: classref-item-separator
  2155. ----
  2156. .. _class_PhysicsServer3D_method_soft_body_set_transform:
  2157. .. rst-class:: classref-method
  2158. |void| **soft_body_set_transform**\ (\ body\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_set_transform>`
  2159. Sets the global transform of the given soft body.
  2160. .. rst-class:: classref-item-separator
  2161. ----
  2162. .. _class_PhysicsServer3D_method_soft_body_update_rendering_server:
  2163. .. rst-class:: classref-method
  2164. |void| **soft_body_update_rendering_server**\ (\ body\: :ref:`RID<class_RID>`, rendering_server_handler\: :ref:`PhysicsServer3DRenderingServerHandler<class_PhysicsServer3DRenderingServerHandler>`\ ) :ref:`🔗<class_PhysicsServer3D_method_soft_body_update_rendering_server>`
  2165. Requests that the physics server updates the rendering server with the latest positions of the given soft body's points through the ``rendering_server_handler`` interface.
  2166. .. rst-class:: classref-item-separator
  2167. ----
  2168. .. _class_PhysicsServer3D_method_space_create:
  2169. .. rst-class:: classref-method
  2170. :ref:`RID<class_RID>` **space_create**\ (\ ) :ref:`🔗<class_PhysicsServer3D_method_space_create>`
  2171. 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>`.
  2172. .. rst-class:: classref-item-separator
  2173. ----
  2174. .. _class_PhysicsServer3D_method_space_get_direct_state:
  2175. .. rst-class:: classref-method
  2176. :ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>` **space_get_direct_state**\ (\ space\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_PhysicsServer3D_method_space_get_direct_state>`
  2177. Returns the state of a space, a :ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>`. This object can be used to make collision/intersection queries.
  2178. .. rst-class:: classref-item-separator
  2179. ----
  2180. .. _class_PhysicsServer3D_method_space_get_param:
  2181. .. rst-class:: classref-method
  2182. :ref:`float<class_float>` **space_get_param**\ (\ space\: :ref:`RID<class_RID>`, param\: :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_space_get_param>`
  2183. Returns the value of a space parameter.
  2184. .. rst-class:: classref-item-separator
  2185. ----
  2186. .. _class_PhysicsServer3D_method_space_is_active:
  2187. .. rst-class:: classref-method
  2188. :ref:`bool<class_bool>` **space_is_active**\ (\ space\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsServer3D_method_space_is_active>`
  2189. Returns whether the space is active.
  2190. .. rst-class:: classref-item-separator
  2191. ----
  2192. .. _class_PhysicsServer3D_method_space_set_active:
  2193. .. rst-class:: classref-method
  2194. |void| **space_set_active**\ (\ space\: :ref:`RID<class_RID>`, active\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_PhysicsServer3D_method_space_set_active>`
  2195. Marks a space as active. It will not have an effect, unless it is assigned to an area or body.
  2196. .. rst-class:: classref-item-separator
  2197. ----
  2198. .. _class_PhysicsServer3D_method_space_set_param:
  2199. .. rst-class:: classref-method
  2200. |void| **space_set_param**\ (\ space\: :ref:`RID<class_RID>`, param\: :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>`, value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PhysicsServer3D_method_space_set_param>`
  2201. Sets the value for a space parameter. A list of available parameters is on the :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` constants.
  2202. .. rst-class:: classref-item-separator
  2203. ----
  2204. .. _class_PhysicsServer3D_method_sphere_shape_create:
  2205. .. rst-class:: classref-method
  2206. :ref:`RID<class_RID>` **sphere_shape_create**\ (\ ) :ref:`🔗<class_PhysicsServer3D_method_sphere_shape_create>`
  2207. Creates a 3D sphere shape in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. Use :ref:`shape_set_data()<class_PhysicsServer3D_method_shape_set_data>` to set the sphere's radius.
  2208. .. rst-class:: classref-item-separator
  2209. ----
  2210. .. _class_PhysicsServer3D_method_world_boundary_shape_create:
  2211. .. rst-class:: classref-method
  2212. :ref:`RID<class_RID>` **world_boundary_shape_create**\ (\ ) :ref:`🔗<class_PhysicsServer3D_method_world_boundary_shape_create>`
  2213. Creates a 3D world boundary shape in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. Use :ref:`shape_set_data()<class_PhysicsServer3D_method_shape_set_data>` to set the shape's normal direction and distance properties.
  2214. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  2215. .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
  2216. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  2217. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  2218. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  2219. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  2220. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  2221. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  2222. .. |void| replace:: :abbr:`void (No return value.)`