123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481 |
- :github_url: hide
- .. DO NOT EDIT THIS FILE!!!
- .. Generated automatically from Godot engine sources.
- .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
- .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer2D.xml.
- .. _class_PhysicsServer2D:
- PhysicsServer2D
- ===============
- **Inherits:** :ref:`Object<class_Object>`
- **Inherited By:** :ref:`PhysicsServer2DExtension<class_PhysicsServer2DExtension>`
- Server interface for low-level 2D physics access.
- .. rst-class:: classref-introduction-group
- Description
- -----------
- PhysicsServer2D is the server responsible for all 2D physics. It can create many kinds of physics objects, but does not insert them on the node tree.
- .. rst-class:: classref-reftable-group
- Methods
- -------
- .. table::
- :widths: auto
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_add_shape<class_PhysicsServer2D_method_area_add_shape>` **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` shape, :ref:`Transform2D<class_Transform2D>` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`bool<class_bool>` disabled=false **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_attach_canvas_instance_id<class_PhysicsServer2D_method_area_attach_canvas_instance_id>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_attach_object_instance_id<class_PhysicsServer2D_method_area_attach_object_instance_id>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_clear_shapes<class_PhysicsServer2D_method_area_clear_shapes>` **(** :ref:`RID<class_RID>` area **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`area_create<class_PhysicsServer2D_method_area_create>` **(** **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`area_get_canvas_instance_id<class_PhysicsServer2D_method_area_get_canvas_instance_id>` **(** :ref:`RID<class_RID>` area **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`area_get_collision_layer<class_PhysicsServer2D_method_area_get_collision_layer>` **(** :ref:`RID<class_RID>` area **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`area_get_collision_mask<class_PhysicsServer2D_method_area_get_collision_mask>` **(** :ref:`RID<class_RID>` area **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`area_get_object_instance_id<class_PhysicsServer2D_method_area_get_object_instance_id>` **(** :ref:`RID<class_RID>` area **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Variant<class_Variant>` | :ref:`area_get_param<class_PhysicsServer2D_method_area_get_param>` **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` param **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`area_get_shape<class_PhysicsServer2D_method_area_get_shape>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`area_get_shape_count<class_PhysicsServer2D_method_area_get_shape_count>` **(** :ref:`RID<class_RID>` area **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Transform2D<class_Transform2D>` | :ref:`area_get_shape_transform<class_PhysicsServer2D_method_area_get_shape_transform>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`area_get_space<class_PhysicsServer2D_method_area_get_space>` **(** :ref:`RID<class_RID>` area **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Transform2D<class_Transform2D>` | :ref:`area_get_transform<class_PhysicsServer2D_method_area_get_transform>` **(** :ref:`RID<class_RID>` area **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_remove_shape<class_PhysicsServer2D_method_area_remove_shape>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_set_area_monitor_callback<class_PhysicsServer2D_method_area_set_area_monitor_callback>` **(** :ref:`RID<class_RID>` area, :ref:`Callable<class_Callable>` callback **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_set_collision_layer<class_PhysicsServer2D_method_area_set_collision_layer>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` layer **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_set_collision_mask<class_PhysicsServer2D_method_area_set_collision_mask>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` mask **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_set_monitor_callback<class_PhysicsServer2D_method_area_set_monitor_callback>` **(** :ref:`RID<class_RID>` area, :ref:`Callable<class_Callable>` callback **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_set_monitorable<class_PhysicsServer2D_method_area_set_monitorable>` **(** :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` monitorable **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_set_param<class_PhysicsServer2D_method_area_set_param>` **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` param, :ref:`Variant<class_Variant>` value **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_set_shape<class_PhysicsServer2D_method_area_set_shape>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_set_shape_disabled<class_PhysicsServer2D_method_area_set_shape_disabled>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_set_shape_transform<class_PhysicsServer2D_method_area_set_shape_transform>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_Transform2D>` transform **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_set_space<class_PhysicsServer2D_method_area_set_space>` **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` space **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_set_transform<class_PhysicsServer2D_method_area_set_transform>` **(** :ref:`RID<class_RID>` area, :ref:`Transform2D<class_Transform2D>` transform **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_add_collision_exception<class_PhysicsServer2D_method_body_add_collision_exception>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_add_constant_central_force<class_PhysicsServer2D_method_body_add_constant_central_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_add_constant_force<class_PhysicsServer2D_method_body_add_constant_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force, :ref:`Vector2<class_Vector2>` position=Vector2(0, 0) **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_add_constant_torque<class_PhysicsServer2D_method_body_add_constant_torque>` **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_add_shape<class_PhysicsServer2D_method_body_add_shape>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` shape, :ref:`Transform2D<class_Transform2D>` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`bool<class_bool>` disabled=false **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_apply_central_force<class_PhysicsServer2D_method_body_apply_central_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_apply_central_impulse<class_PhysicsServer2D_method_body_apply_central_impulse>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` impulse **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_apply_force<class_PhysicsServer2D_method_body_apply_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force, :ref:`Vector2<class_Vector2>` position=Vector2(0, 0) **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_apply_impulse<class_PhysicsServer2D_method_body_apply_impulse>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` impulse, :ref:`Vector2<class_Vector2>` position=Vector2(0, 0) **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_apply_torque<class_PhysicsServer2D_method_body_apply_torque>` **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_apply_torque_impulse<class_PhysicsServer2D_method_body_apply_torque_impulse>` **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` impulse **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_attach_canvas_instance_id<class_PhysicsServer2D_method_body_attach_canvas_instance_id>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_attach_object_instance_id<class_PhysicsServer2D_method_body_attach_object_instance_id>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_clear_shapes<class_PhysicsServer2D_method_body_clear_shapes>` **(** :ref:`RID<class_RID>` body **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`body_create<class_PhysicsServer2D_method_body_create>` **(** **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`body_get_canvas_instance_id<class_PhysicsServer2D_method_body_get_canvas_instance_id>` **(** :ref:`RID<class_RID>` body **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`body_get_collision_layer<class_PhysicsServer2D_method_body_get_collision_layer>` **(** :ref:`RID<class_RID>` body **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`body_get_collision_mask<class_PhysicsServer2D_method_body_get_collision_mask>` **(** :ref:`RID<class_RID>` body **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`body_get_collision_priority<class_PhysicsServer2D_method_body_get_collision_priority>` **(** :ref:`RID<class_RID>` body **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Vector2<class_Vector2>` | :ref:`body_get_constant_force<class_PhysicsServer2D_method_body_get_constant_force>` **(** :ref:`RID<class_RID>` body **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`body_get_constant_torque<class_PhysicsServer2D_method_body_get_constant_torque>` **(** :ref:`RID<class_RID>` body **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` | :ref:`body_get_continuous_collision_detection_mode<class_PhysicsServer2D_method_body_get_continuous_collision_detection_mode>` **(** :ref:`RID<class_RID>` body **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PhysicsDirectBodyState2D<class_PhysicsDirectBodyState2D>` | :ref:`body_get_direct_state<class_PhysicsServer2D_method_body_get_direct_state>` **(** :ref:`RID<class_RID>` body **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`body_get_max_contacts_reported<class_PhysicsServer2D_method_body_get_max_contacts_reported>` **(** :ref:`RID<class_RID>` body **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` | :ref:`body_get_mode<class_PhysicsServer2D_method_body_get_mode>` **(** :ref:`RID<class_RID>` body **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`body_get_object_instance_id<class_PhysicsServer2D_method_body_get_object_instance_id>` **(** :ref:`RID<class_RID>` body **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Variant<class_Variant>` | :ref:`body_get_param<class_PhysicsServer2D_method_body_get_param>` **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` param **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`body_get_shape<class_PhysicsServer2D_method_body_get_shape>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`body_get_shape_count<class_PhysicsServer2D_method_body_get_shape_count>` **(** :ref:`RID<class_RID>` body **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Transform2D<class_Transform2D>` | :ref:`body_get_shape_transform<class_PhysicsServer2D_method_body_get_shape_transform>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`body_get_space<class_PhysicsServer2D_method_body_get_space>` **(** :ref:`RID<class_RID>` body **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Variant<class_Variant>` | :ref:`body_get_state<class_PhysicsServer2D_method_body_get_state>` **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_PhysicsServer2D_BodyState>` state **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`body_is_omitting_force_integration<class_PhysicsServer2D_method_body_is_omitting_force_integration>` **(** :ref:`RID<class_RID>` body **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_remove_collision_exception<class_PhysicsServer2D_method_body_remove_collision_exception>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_remove_shape<class_PhysicsServer2D_method_body_remove_shape>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_reset_mass_properties<class_PhysicsServer2D_method_body_reset_mass_properties>` **(** :ref:`RID<class_RID>` body **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_axis_velocity<class_PhysicsServer2D_method_body_set_axis_velocity>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` axis_velocity **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_collision_layer<class_PhysicsServer2D_method_body_set_collision_layer>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` layer **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_collision_mask<class_PhysicsServer2D_method_body_set_collision_mask>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` mask **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_collision_priority<class_PhysicsServer2D_method_body_set_collision_priority>` **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` priority **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_constant_force<class_PhysicsServer2D_method_body_set_constant_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_constant_torque<class_PhysicsServer2D_method_body_set_constant_torque>` **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_continuous_collision_detection_mode<class_PhysicsServer2D_method_body_set_continuous_collision_detection_mode>` **(** :ref:`RID<class_RID>` body, :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` mode **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_force_integration_callback<class_PhysicsServer2D_method_body_set_force_integration_callback>` **(** :ref:`RID<class_RID>` body, :ref:`Callable<class_Callable>` callable, :ref:`Variant<class_Variant>` userdata=null **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_max_contacts_reported<class_PhysicsServer2D_method_body_set_max_contacts_reported>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` amount **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_mode<class_PhysicsServer2D_method_body_set_mode>` **(** :ref:`RID<class_RID>` body, :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` mode **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_omit_force_integration<class_PhysicsServer2D_method_body_set_omit_force_integration>` **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_param<class_PhysicsServer2D_method_body_set_param>` **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` param, :ref:`Variant<class_Variant>` value **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_shape<class_PhysicsServer2D_method_body_set_shape>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_shape_as_one_way_collision<class_PhysicsServer2D_method_body_set_shape_as_one_way_collision>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` margin **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_shape_disabled<class_PhysicsServer2D_method_body_set_shape_disabled>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_shape_transform<class_PhysicsServer2D_method_body_set_shape_transform>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_Transform2D>` transform **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_space<class_PhysicsServer2D_method_body_set_space>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` space **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_state<class_PhysicsServer2D_method_body_set_state>` **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_PhysicsServer2D_BodyState>` state, :ref:`Variant<class_Variant>` value **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`body_test_motion<class_PhysicsServer2D_method_body_test_motion>` **(** :ref:`RID<class_RID>` body, :ref:`PhysicsTestMotionParameters2D<class_PhysicsTestMotionParameters2D>` parameters, :ref:`PhysicsTestMotionResult2D<class_PhysicsTestMotionResult2D>` result=null **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`capsule_shape_create<class_PhysicsServer2D_method_capsule_shape_create>` **(** **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`circle_shape_create<class_PhysicsServer2D_method_circle_shape_create>` **(** **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`concave_polygon_shape_create<class_PhysicsServer2D_method_concave_polygon_shape_create>` **(** **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`convex_polygon_shape_create<class_PhysicsServer2D_method_convex_polygon_shape_create>` **(** **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`damped_spring_joint_get_param<class_PhysicsServer2D_method_damped_spring_joint_get_param>` **(** :ref:`RID<class_RID>` joint, :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` param **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`damped_spring_joint_set_param<class_PhysicsServer2D_method_damped_spring_joint_set_param>` **(** :ref:`RID<class_RID>` joint, :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` param, :ref:`float<class_float>` value **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`free_rid<class_PhysicsServer2D_method_free_rid>` **(** :ref:`RID<class_RID>` rid **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_process_info<class_PhysicsServer2D_method_get_process_info>` **(** :ref:`ProcessInfo<enum_PhysicsServer2D_ProcessInfo>` process_info **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`joint_clear<class_PhysicsServer2D_method_joint_clear>` **(** :ref:`RID<class_RID>` joint **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`joint_create<class_PhysicsServer2D_method_joint_create>` **(** **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`joint_disable_collisions_between_bodies<class_PhysicsServer2D_method_joint_disable_collisions_between_bodies>` **(** :ref:`RID<class_RID>` joint, :ref:`bool<class_bool>` disable **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`joint_get_param<class_PhysicsServer2D_method_joint_get_param>` **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_PhysicsServer2D_JointParam>` param **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`JointType<enum_PhysicsServer2D_JointType>` | :ref:`joint_get_type<class_PhysicsServer2D_method_joint_get_type>` **(** :ref:`RID<class_RID>` joint **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`joint_is_disabled_collisions_between_bodies<class_PhysicsServer2D_method_joint_is_disabled_collisions_between_bodies>` **(** :ref:`RID<class_RID>` joint **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`joint_make_damped_spring<class_PhysicsServer2D_method_joint_make_damped_spring>` **(** :ref:`RID<class_RID>` joint, :ref:`Vector2<class_Vector2>` anchor_a, :ref:`Vector2<class_Vector2>` anchor_b, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`joint_make_groove<class_PhysicsServer2D_method_joint_make_groove>` **(** :ref:`RID<class_RID>` joint, :ref:`Vector2<class_Vector2>` groove1_a, :ref:`Vector2<class_Vector2>` groove2_a, :ref:`Vector2<class_Vector2>` anchor_b, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`joint_make_pin<class_PhysicsServer2D_method_joint_make_pin>` **(** :ref:`RID<class_RID>` joint, :ref:`Vector2<class_Vector2>` anchor, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`joint_set_param<class_PhysicsServer2D_method_joint_set_param>` **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_PhysicsServer2D_JointParam>` param, :ref:`float<class_float>` value **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`rectangle_shape_create<class_PhysicsServer2D_method_rectangle_shape_create>` **(** **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`segment_shape_create<class_PhysicsServer2D_method_segment_shape_create>` **(** **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`separation_ray_shape_create<class_PhysicsServer2D_method_separation_ray_shape_create>` **(** **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_active<class_PhysicsServer2D_method_set_active>` **(** :ref:`bool<class_bool>` active **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Variant<class_Variant>` | :ref:`shape_get_data<class_PhysicsServer2D_method_shape_get_data>` **(** :ref:`RID<class_RID>` shape **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` | :ref:`shape_get_type<class_PhysicsServer2D_method_shape_get_type>` **(** :ref:`RID<class_RID>` shape **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`shape_set_data<class_PhysicsServer2D_method_shape_set_data>` **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_Variant>` data **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`space_create<class_PhysicsServer2D_method_space_create>` **(** **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PhysicsDirectSpaceState2D<class_PhysicsDirectSpaceState2D>` | :ref:`space_get_direct_state<class_PhysicsServer2D_method_space_get_direct_state>` **(** :ref:`RID<class_RID>` space **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`space_get_param<class_PhysicsServer2D_method_space_get_param>` **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` param **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`space_is_active<class_PhysicsServer2D_method_space_is_active>` **(** :ref:`RID<class_RID>` space **)** |const| |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`space_set_active<class_PhysicsServer2D_method_space_set_active>` **(** :ref:`RID<class_RID>` space, :ref:`bool<class_bool>` active **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`space_set_param<class_PhysicsServer2D_method_space_set_param>` **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` param, :ref:`float<class_float>` value **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`world_boundary_shape_create<class_PhysicsServer2D_method_world_boundary_shape_create>` **(** **)** |
- +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Enumerations
- ------------
- .. _enum_PhysicsServer2D_SpaceParameter:
- .. rst-class:: classref-enumeration
- enum **SpaceParameter**:
- .. _class_PhysicsServer2D_constant_SPACE_PARAM_CONTACT_RECYCLE_RADIUS:
- .. rst-class:: classref-enumeration-constant
- :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` **SPACE_PARAM_CONTACT_RECYCLE_RADIUS** = ``0``
- Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated.
- .. _class_PhysicsServer2D_constant_SPACE_PARAM_CONTACT_MAX_SEPARATION:
- .. rst-class:: classref-enumeration-constant
- :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` **SPACE_PARAM_CONTACT_MAX_SEPARATION** = ``1``
- Constant to set/get the maximum distance a shape can be from another before they are considered separated and the contact is discarded.
- .. _class_PhysicsServer2D_constant_SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION:
- .. rst-class:: classref-enumeration-constant
- :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` **SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION** = ``2``
- Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision.
- .. _class_PhysicsServer2D_constant_SPACE_PARAM_CONTACT_DEFAULT_BIAS:
- .. rst-class:: classref-enumeration-constant
- :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` **SPACE_PARAM_CONTACT_DEFAULT_BIAS** = ``3``
- 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.
- .. _class_PhysicsServer2D_constant_SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD:
- .. rst-class:: classref-enumeration-constant
- :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` **SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD** = ``4``
- 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.
- .. _class_PhysicsServer2D_constant_SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD:
- .. rst-class:: classref-enumeration-constant
- :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` **SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD** = ``5``
- 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.
- .. _class_PhysicsServer2D_constant_SPACE_PARAM_BODY_TIME_TO_SLEEP:
- .. rst-class:: classref-enumeration-constant
- :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` **SPACE_PARAM_BODY_TIME_TO_SLEEP** = ``6``
- 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.
- .. _class_PhysicsServer2D_constant_SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS:
- .. rst-class:: classref-enumeration-constant
- :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` **SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS** = ``7``
- Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision.
- .. _class_PhysicsServer2D_constant_SPACE_PARAM_SOLVER_ITERATIONS:
- .. rst-class:: classref-enumeration-constant
- :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` **SPACE_PARAM_SOLVER_ITERATIONS** = ``8``
- Constant to set/get the number of solver iterations for all contacts and constraints. The greater the number of iterations, the more accurate the collisions will be. However, a greater number of iterations requires more CPU power, which can decrease performance.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_PhysicsServer2D_ShapeType:
- .. rst-class:: classref-enumeration
- enum **ShapeType**:
- .. _class_PhysicsServer2D_constant_SHAPE_WORLD_BOUNDARY:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **SHAPE_WORLD_BOUNDARY** = ``0``
- This is the constant for creating world boundary shapes. A world boundary shape is an *infinite* line with an origin point, and a normal. Thus, it can be used for front/behind checks.
- .. _class_PhysicsServer2D_constant_SHAPE_SEPARATION_RAY:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **SHAPE_SEPARATION_RAY** = ``1``
- This is the constant for creating separation ray shapes. A separation ray is defined by a length and separates itself from what is touching its far endpoint. Useful for character controllers.
- .. _class_PhysicsServer2D_constant_SHAPE_SEGMENT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **SHAPE_SEGMENT** = ``2``
- This is the constant for creating segment shapes. A segment shape is a *finite* line from a point A to a point B. It can be checked for intersections.
- .. _class_PhysicsServer2D_constant_SHAPE_CIRCLE:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **SHAPE_CIRCLE** = ``3``
- This is the constant for creating circle shapes. A circle shape only has a radius. It can be used for intersections and inside/outside checks.
- .. _class_PhysicsServer2D_constant_SHAPE_RECTANGLE:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **SHAPE_RECTANGLE** = ``4``
- This is the constant for creating rectangle shapes. A rectangle shape is defined by a width and a height. It can be used for intersections and inside/outside checks.
- .. _class_PhysicsServer2D_constant_SHAPE_CAPSULE:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **SHAPE_CAPSULE** = ``5``
- This is the constant for creating capsule shapes. A capsule shape is defined by a radius and a length. It can be used for intersections and inside/outside checks.
- .. _class_PhysicsServer2D_constant_SHAPE_CONVEX_POLYGON:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **SHAPE_CONVEX_POLYGON** = ``6``
- This is the constant for creating convex polygon shapes. A polygon is defined by a list of points. It can be used for intersections and inside/outside checks. Unlike the :ref:`CollisionPolygon2D.polygon<class_CollisionPolygon2D_property_polygon>` property, polygons modified with :ref:`shape_set_data<class_PhysicsServer2D_method_shape_set_data>` do not verify that the points supplied form is a convex polygon.
- .. _class_PhysicsServer2D_constant_SHAPE_CONCAVE_POLYGON:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **SHAPE_CONCAVE_POLYGON** = ``7``
- This is the constant for creating concave polygon shapes. A polygon is defined by a list of points. It can be used for intersections checks, but not for inside/outside checks.
- .. _class_PhysicsServer2D_constant_SHAPE_CUSTOM:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **SHAPE_CUSTOM** = ``8``
- This constant is used internally by the engine. Any attempt to create this kind of shape results in an error.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_PhysicsServer2D_AreaParameter:
- .. rst-class:: classref-enumeration
- enum **AreaParameter**:
- .. _class_PhysicsServer2D_constant_AREA_PARAM_GRAVITY_OVERRIDE_MODE:
- .. rst-class:: classref-enumeration-constant
- :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_GRAVITY_OVERRIDE_MODE** = ``0``
- Constant to set/get gravity override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` for possible values.
- .. _class_PhysicsServer2D_constant_AREA_PARAM_GRAVITY:
- .. rst-class:: classref-enumeration-constant
- :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_GRAVITY** = ``1``
- Constant to set/get gravity strength in an area.
- .. _class_PhysicsServer2D_constant_AREA_PARAM_GRAVITY_VECTOR:
- .. rst-class:: classref-enumeration-constant
- :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_GRAVITY_VECTOR** = ``2``
- Constant to set/get gravity vector/center in an area.
- .. _class_PhysicsServer2D_constant_AREA_PARAM_GRAVITY_IS_POINT:
- .. rst-class:: classref-enumeration-constant
- :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_GRAVITY_IS_POINT** = ``3``
- Constant to set/get whether the gravity vector of an area is a direction, or a center point.
- .. _class_PhysicsServer2D_constant_AREA_PARAM_GRAVITY_DISTANCE_SCALE:
- .. rst-class:: classref-enumeration-constant
- :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_GRAVITY_DISTANCE_SCALE** = ``4``
- Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance.
- .. _class_PhysicsServer2D_constant_AREA_PARAM_GRAVITY_POINT_ATTENUATION:
- .. rst-class:: classref-enumeration-constant
- :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_GRAVITY_POINT_ATTENUATION** = ``5``
- This constant was used to set/get the falloff factor for point gravity. It has been superseded by :ref:`AREA_PARAM_GRAVITY_DISTANCE_SCALE<class_PhysicsServer2D_constant_AREA_PARAM_GRAVITY_DISTANCE_SCALE>`.
- .. _class_PhysicsServer2D_constant_AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE:
- .. rst-class:: classref-enumeration-constant
- :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE** = ``6``
- Constant to set/get linear damping override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` for possible values.
- .. _class_PhysicsServer2D_constant_AREA_PARAM_LINEAR_DAMP:
- .. rst-class:: classref-enumeration-constant
- :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_LINEAR_DAMP** = ``7``
- Constant to set/get the linear damping factor of an area.
- .. _class_PhysicsServer2D_constant_AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE:
- .. rst-class:: classref-enumeration-constant
- :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE** = ``8``
- Constant to set/get angular damping override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` for possible values.
- .. _class_PhysicsServer2D_constant_AREA_PARAM_ANGULAR_DAMP:
- .. rst-class:: classref-enumeration-constant
- :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_ANGULAR_DAMP** = ``9``
- Constant to set/get the angular damping factor of an area.
- .. _class_PhysicsServer2D_constant_AREA_PARAM_PRIORITY:
- .. rst-class:: classref-enumeration-constant
- :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` **AREA_PARAM_PRIORITY** = ``10``
- Constant to set/get the priority (order of processing) of an area.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_PhysicsServer2D_AreaSpaceOverrideMode:
- .. rst-class:: classref-enumeration
- enum **AreaSpaceOverrideMode**:
- .. _class_PhysicsServer2D_constant_AREA_SPACE_OVERRIDE_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_DISABLED** = ``0``
- This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
- .. _class_PhysicsServer2D_constant_AREA_SPACE_OVERRIDE_COMBINE:
- .. rst-class:: classref-enumeration-constant
- :ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_COMBINE** = ``1``
- 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.
- .. _class_PhysicsServer2D_constant_AREA_SPACE_OVERRIDE_COMBINE_REPLACE:
- .. rst-class:: classref-enumeration-constant
- :ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_COMBINE_REPLACE** = ``2``
- 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.
- .. _class_PhysicsServer2D_constant_AREA_SPACE_OVERRIDE_REPLACE:
- .. rst-class:: classref-enumeration-constant
- :ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_REPLACE** = ``3``
- This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
- .. _class_PhysicsServer2D_constant_AREA_SPACE_OVERRIDE_REPLACE_COMBINE:
- .. rst-class:: classref-enumeration-constant
- :ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` **AREA_SPACE_OVERRIDE_REPLACE_COMBINE** = ``4``
- This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_PhysicsServer2D_BodyMode:
- .. rst-class:: classref-enumeration
- enum **BodyMode**:
- .. _class_PhysicsServer2D_constant_BODY_MODE_STATIC:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` **BODY_MODE_STATIC** = ``0``
- 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.
- .. _class_PhysicsServer2D_constant_BODY_MODE_KINEMATIC:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` **BODY_MODE_KINEMATIC** = ``1``
- Constant for kinematic bodies. In this mode, a body can be only moved by user code and collides with other bodies along its path.
- .. _class_PhysicsServer2D_constant_BODY_MODE_RIGID:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` **BODY_MODE_RIGID** = ``2``
- Constant for rigid bodies. In this mode, a body can be pushed by other bodies and has forces applied.
- .. _class_PhysicsServer2D_constant_BODY_MODE_RIGID_LINEAR:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` **BODY_MODE_RIGID_LINEAR** = ``3``
- Constant for linear rigid bodies. In this mode, a body can not rotate, and only its linear velocity is affected by external forces.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_PhysicsServer2D_BodyParameter:
- .. rst-class:: classref-enumeration
- enum **BodyParameter**:
- .. _class_PhysicsServer2D_constant_BODY_PARAM_BOUNCE:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_BOUNCE** = ``0``
- Constant to set/get a body's bounce factor.
- .. _class_PhysicsServer2D_constant_BODY_PARAM_FRICTION:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_FRICTION** = ``1``
- Constant to set/get a body's friction.
- .. _class_PhysicsServer2D_constant_BODY_PARAM_MASS:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_MASS** = ``2``
- Constant to set/get a body's mass.
- .. _class_PhysicsServer2D_constant_BODY_PARAM_INERTIA:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_INERTIA** = ``3``
- Constant to set/get a body's inertia.
- .. _class_PhysicsServer2D_constant_BODY_PARAM_CENTER_OF_MASS:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_CENTER_OF_MASS** = ``4``
- Constant to set/get a body's center of mass position in the body's local coordinate system.
- .. _class_PhysicsServer2D_constant_BODY_PARAM_GRAVITY_SCALE:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_GRAVITY_SCALE** = ``5``
- Constant to set/get a body's gravity multiplier.
- .. _class_PhysicsServer2D_constant_BODY_PARAM_LINEAR_DAMP_MODE:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_LINEAR_DAMP_MODE** = ``6``
- Constant to set/get a body's linear dampening mode. See :ref:`BodyDampMode<enum_PhysicsServer2D_BodyDampMode>` for possible values.
- .. _class_PhysicsServer2D_constant_BODY_PARAM_ANGULAR_DAMP_MODE:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_ANGULAR_DAMP_MODE** = ``7``
- Constant to set/get a body's angular dampening mode. See :ref:`BodyDampMode<enum_PhysicsServer2D_BodyDampMode>` for possible values.
- .. _class_PhysicsServer2D_constant_BODY_PARAM_LINEAR_DAMP:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_LINEAR_DAMP** = ``8``
- Constant to set/get a body's linear dampening factor.
- .. _class_PhysicsServer2D_constant_BODY_PARAM_ANGULAR_DAMP:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_ANGULAR_DAMP** = ``9``
- Constant to set/get a body's angular dampening factor.
- .. _class_PhysicsServer2D_constant_BODY_PARAM_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` **BODY_PARAM_MAX** = ``10``
- Represents the size of the :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_PhysicsServer2D_BodyDampMode:
- .. rst-class:: classref-enumeration
- enum **BodyDampMode**:
- .. _class_PhysicsServer2D_constant_BODY_DAMP_MODE_COMBINE:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyDampMode<enum_PhysicsServer2D_BodyDampMode>` **BODY_DAMP_MODE_COMBINE** = ``0``
- The body's damping value is added to any value set in areas or the default value.
- .. _class_PhysicsServer2D_constant_BODY_DAMP_MODE_REPLACE:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyDampMode<enum_PhysicsServer2D_BodyDampMode>` **BODY_DAMP_MODE_REPLACE** = ``1``
- The body's damping value replaces any value set in areas or the default value.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_PhysicsServer2D_BodyState:
- .. rst-class:: classref-enumeration
- enum **BodyState**:
- .. _class_PhysicsServer2D_constant_BODY_STATE_TRANSFORM:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyState<enum_PhysicsServer2D_BodyState>` **BODY_STATE_TRANSFORM** = ``0``
- Constant to set/get the current transform matrix of the body.
- .. _class_PhysicsServer2D_constant_BODY_STATE_LINEAR_VELOCITY:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyState<enum_PhysicsServer2D_BodyState>` **BODY_STATE_LINEAR_VELOCITY** = ``1``
- Constant to set/get the current linear velocity of the body.
- .. _class_PhysicsServer2D_constant_BODY_STATE_ANGULAR_VELOCITY:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyState<enum_PhysicsServer2D_BodyState>` **BODY_STATE_ANGULAR_VELOCITY** = ``2``
- Constant to set/get the current angular velocity of the body.
- .. _class_PhysicsServer2D_constant_BODY_STATE_SLEEPING:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyState<enum_PhysicsServer2D_BodyState>` **BODY_STATE_SLEEPING** = ``3``
- Constant to sleep/wake up a body, or to get whether it is sleeping.
- .. _class_PhysicsServer2D_constant_BODY_STATE_CAN_SLEEP:
- .. rst-class:: classref-enumeration-constant
- :ref:`BodyState<enum_PhysicsServer2D_BodyState>` **BODY_STATE_CAN_SLEEP** = ``4``
- Constant to set/get whether the body can sleep.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_PhysicsServer2D_JointType:
- .. rst-class:: classref-enumeration
- enum **JointType**:
- .. _class_PhysicsServer2D_constant_JOINT_TYPE_PIN:
- .. rst-class:: classref-enumeration-constant
- :ref:`JointType<enum_PhysicsServer2D_JointType>` **JOINT_TYPE_PIN** = ``0``
- Constant to create pin joints.
- .. _class_PhysicsServer2D_constant_JOINT_TYPE_GROOVE:
- .. rst-class:: classref-enumeration-constant
- :ref:`JointType<enum_PhysicsServer2D_JointType>` **JOINT_TYPE_GROOVE** = ``1``
- Constant to create groove joints.
- .. _class_PhysicsServer2D_constant_JOINT_TYPE_DAMPED_SPRING:
- .. rst-class:: classref-enumeration-constant
- :ref:`JointType<enum_PhysicsServer2D_JointType>` **JOINT_TYPE_DAMPED_SPRING** = ``2``
- Constant to create damped spring joints.
- .. _class_PhysicsServer2D_constant_JOINT_TYPE_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`JointType<enum_PhysicsServer2D_JointType>` **JOINT_TYPE_MAX** = ``3``
- Represents the size of the :ref:`JointType<enum_PhysicsServer2D_JointType>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_PhysicsServer2D_JointParam:
- .. rst-class:: classref-enumeration
- enum **JointParam**:
- .. _class_PhysicsServer2D_constant_JOINT_PARAM_BIAS:
- .. rst-class:: classref-enumeration-constant
- :ref:`JointParam<enum_PhysicsServer2D_JointParam>` **JOINT_PARAM_BIAS** = ``0``
- .. _class_PhysicsServer2D_constant_JOINT_PARAM_MAX_BIAS:
- .. rst-class:: classref-enumeration-constant
- :ref:`JointParam<enum_PhysicsServer2D_JointParam>` **JOINT_PARAM_MAX_BIAS** = ``1``
- .. _class_PhysicsServer2D_constant_JOINT_PARAM_MAX_FORCE:
- .. rst-class:: classref-enumeration-constant
- :ref:`JointParam<enum_PhysicsServer2D_JointParam>` **JOINT_PARAM_MAX_FORCE** = ``2``
- .. rst-class:: classref-item-separator
- ----
- .. _enum_PhysicsServer2D_PinJointParam:
- .. rst-class:: classref-enumeration
- enum **PinJointParam**:
- .. _class_PhysicsServer2D_constant_PIN_JOINT_SOFTNESS:
- .. rst-class:: classref-enumeration-constant
- :ref:`PinJointParam<enum_PhysicsServer2D_PinJointParam>` **PIN_JOINT_SOFTNESS** = ``0``
- .. rst-class:: classref-item-separator
- ----
- .. _enum_PhysicsServer2D_DampedSpringParam:
- .. rst-class:: classref-enumeration
- enum **DampedSpringParam**:
- .. _class_PhysicsServer2D_constant_DAMPED_SPRING_REST_LENGTH:
- .. rst-class:: classref-enumeration-constant
- :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` **DAMPED_SPRING_REST_LENGTH** = ``0``
- Sets the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
- .. _class_PhysicsServer2D_constant_DAMPED_SPRING_STIFFNESS:
- .. rst-class:: classref-enumeration-constant
- :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` **DAMPED_SPRING_STIFFNESS** = ``1``
- Sets the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
- .. _class_PhysicsServer2D_constant_DAMPED_SPRING_DAMPING:
- .. rst-class:: classref-enumeration-constant
- :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` **DAMPED_SPRING_DAMPING** = ``2``
- Sets the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
- .. rst-class:: classref-item-separator
- ----
- .. _enum_PhysicsServer2D_CCDMode:
- .. rst-class:: classref-enumeration
- enum **CCDMode**:
- .. _class_PhysicsServer2D_constant_CCD_MODE_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` **CCD_MODE_DISABLED** = ``0``
- Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects.
- .. _class_PhysicsServer2D_constant_CCD_MODE_CAST_RAY:
- .. rst-class:: classref-enumeration-constant
- :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` **CCD_MODE_CAST_RAY** = ``1``
- Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise.
- .. _class_PhysicsServer2D_constant_CCD_MODE_CAST_SHAPE:
- .. rst-class:: classref-enumeration-constant
- :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` **CCD_MODE_CAST_SHAPE** = ``2``
- Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_PhysicsServer2D_AreaBodyStatus:
- .. rst-class:: classref-enumeration
- enum **AreaBodyStatus**:
- .. _class_PhysicsServer2D_constant_AREA_BODY_ADDED:
- .. rst-class:: classref-enumeration-constant
- :ref:`AreaBodyStatus<enum_PhysicsServer2D_AreaBodyStatus>` **AREA_BODY_ADDED** = ``0``
- The value of the first parameter and area callback function receives, when an object enters one of its shapes.
- .. _class_PhysicsServer2D_constant_AREA_BODY_REMOVED:
- .. rst-class:: classref-enumeration-constant
- :ref:`AreaBodyStatus<enum_PhysicsServer2D_AreaBodyStatus>` **AREA_BODY_REMOVED** = ``1``
- The value of the first parameter and area callback function receives, when an object exits one of its shapes.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_PhysicsServer2D_ProcessInfo:
- .. rst-class:: classref-enumeration
- enum **ProcessInfo**:
- .. _class_PhysicsServer2D_constant_INFO_ACTIVE_OBJECTS:
- .. rst-class:: classref-enumeration-constant
- :ref:`ProcessInfo<enum_PhysicsServer2D_ProcessInfo>` **INFO_ACTIVE_OBJECTS** = ``0``
- Constant to get the number of objects that are not sleeping.
- .. _class_PhysicsServer2D_constant_INFO_COLLISION_PAIRS:
- .. rst-class:: classref-enumeration-constant
- :ref:`ProcessInfo<enum_PhysicsServer2D_ProcessInfo>` **INFO_COLLISION_PAIRS** = ``1``
- Constant to get the number of possible collisions.
- .. _class_PhysicsServer2D_constant_INFO_ISLAND_COUNT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ProcessInfo<enum_PhysicsServer2D_ProcessInfo>` **INFO_ISLAND_COUNT** = ``2``
- Constant to get the number of space regions where a collision could occur.
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Method Descriptions
- -------------------
- .. _class_PhysicsServer2D_method_area_add_shape:
- .. rst-class:: classref-method
- void **area_add_shape** **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` shape, :ref:`Transform2D<class_Transform2D>` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`bool<class_bool>` disabled=false **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_attach_canvas_instance_id:
- .. rst-class:: classref-method
- void **area_attach_canvas_instance_id** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_attach_object_instance_id:
- .. rst-class:: classref-method
- void **area_attach_object_instance_id** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)**
- Assigns the area to a descendant of :ref:`Object<class_Object>`, so it can exist in the node tree.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_clear_shapes:
- .. rst-class:: classref-method
- void **area_clear_shapes** **(** :ref:`RID<class_RID>` area **)**
- Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **area_create** **(** **)**
- Creates an :ref:`Area2D<class_Area2D>`. After creating an :ref:`Area2D<class_Area2D>` with this method, assign it to a space using :ref:`area_set_space<class_PhysicsServer2D_method_area_set_space>` to use the created :ref:`Area2D<class_Area2D>` in the physics world.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_get_canvas_instance_id:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **area_get_canvas_instance_id** **(** :ref:`RID<class_RID>` area **)** |const|
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_get_collision_layer:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **area_get_collision_layer** **(** :ref:`RID<class_RID>` area **)** |const|
- Returns the physics layer or layers an area belongs to.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_get_collision_mask:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **area_get_collision_mask** **(** :ref:`RID<class_RID>` area **)** |const|
- Returns the physics layer or layers an area can contact with.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_get_object_instance_id:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **area_get_object_instance_id** **(** :ref:`RID<class_RID>` area **)** |const|
- Gets the instance ID of the object the area is assigned to.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_get_param:
- .. rst-class:: classref-method
- :ref:`Variant<class_Variant>` **area_get_param** **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` param **)** |const|
- Returns an area parameter value. See :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` for a list of available parameters.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_get_shape:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **area_get_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |const|
- Returns the :ref:`RID<class_RID>` of the nth shape of an area.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_get_shape_count:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **area_get_shape_count** **(** :ref:`RID<class_RID>` area **)** |const|
- Returns the number of shapes assigned to an area.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_get_shape_transform:
- .. rst-class:: classref-method
- :ref:`Transform2D<class_Transform2D>` **area_get_shape_transform** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |const|
- Returns the transform matrix of a shape within an area.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_get_space:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **area_get_space** **(** :ref:`RID<class_RID>` area **)** |const|
- Returns the space assigned to the area.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_get_transform:
- .. rst-class:: classref-method
- :ref:`Transform2D<class_Transform2D>` **area_get_transform** **(** :ref:`RID<class_RID>` area **)** |const|
- Returns the transform matrix for an area.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_remove_shape:
- .. rst-class:: classref-method
- void **area_remove_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)**
- Removes a shape from an area. It does not delete the shape, so it can be reassigned later.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_set_area_monitor_callback:
- .. rst-class:: classref-method
- void **area_set_area_monitor_callback** **(** :ref:`RID<class_RID>` area, :ref:`Callable<class_Callable>` callback **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_set_collision_layer:
- .. rst-class:: classref-method
- void **area_set_collision_layer** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` layer **)**
- Assigns the area to one or many physics layers.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_set_collision_mask:
- .. rst-class:: classref-method
- void **area_set_collision_mask** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` mask **)**
- Sets which physics layers the area will monitor.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_set_monitor_callback:
- .. rst-class:: classref-method
- void **area_set_monitor_callback** **(** :ref:`RID<class_RID>` area, :ref:`Callable<class_Callable>` callback **)**
- Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters:
- 1: :ref:`AREA_BODY_ADDED<class_PhysicsServer2D_constant_AREA_BODY_ADDED>` or :ref:`AREA_BODY_REMOVED<class_PhysicsServer2D_constant_AREA_BODY_REMOVED>`, depending on whether the object entered or exited the area.
- 2: :ref:`RID<class_RID>` of the object that entered/exited the area.
- 3: Instance ID of the object that entered/exited the area.
- 4: The shape index of the object that entered/exited the area.
- 5: The shape index of the area where the object entered/exited.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_set_monitorable:
- .. rst-class:: classref-method
- void **area_set_monitorable** **(** :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` monitorable **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_set_param:
- .. rst-class:: classref-method
- void **area_set_param** **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` param, :ref:`Variant<class_Variant>` value **)**
- Sets the value for an area parameter. See :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` for a list of available parameters.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_set_shape:
- .. rst-class:: classref-method
- void **area_set_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)**
- Substitutes a given area shape by another. The old shape is selected by its index, the new one by its :ref:`RID<class_RID>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_set_shape_disabled:
- .. rst-class:: classref-method
- void **area_set_shape_disabled** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)**
- Disables a given shape in an area.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_set_shape_transform:
- .. rst-class:: classref-method
- void **area_set_shape_transform** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_Transform2D>` transform **)**
- Sets the transform matrix for an area shape.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_set_space:
- .. rst-class:: classref-method
- void **area_set_space** **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` space **)**
- Assigns a space to the area.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_area_set_transform:
- .. rst-class:: classref-method
- void **area_set_transform** **(** :ref:`RID<class_RID>` area, :ref:`Transform2D<class_Transform2D>` transform **)**
- Sets the transform matrix for an area.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_add_collision_exception:
- .. rst-class:: classref-method
- void **body_add_collision_exception** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)**
- Adds a body to the list of bodies exempt from collisions.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_add_constant_central_force:
- .. rst-class:: classref-method
- void **body_add_constant_central_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)**
- Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with ``body_set_constant_force(body, Vector2(0, 0))``.
- This is equivalent to using :ref:`body_add_constant_force<class_PhysicsServer2D_method_body_add_constant_force>` at the body's center of mass.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_add_constant_force:
- .. rst-class:: classref-method
- void **body_add_constant_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force, :ref:`Vector2<class_Vector2>` position=Vector2(0, 0) **)**
- Adds a constant positioned force to the body that keeps being applied over time until cleared with ``body_set_constant_force(body, Vector2(0, 0))``.
- \ ``position`` is the offset from the body origin in global coordinates.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_add_constant_torque:
- .. rst-class:: classref-method
- void **body_add_constant_torque** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)**
- Adds a constant rotational force without affecting position that keeps being applied over time until cleared with ``body_set_constant_torque(body, 0)``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_add_shape:
- .. rst-class:: classref-method
- void **body_add_shape** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` shape, :ref:`Transform2D<class_Transform2D>` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`bool<class_bool>` disabled=false **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_apply_central_force:
- .. rst-class:: classref-method
- void **body_apply_central_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)**
- Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update.
- This is equivalent to using :ref:`body_apply_force<class_PhysicsServer2D_method_body_apply_force>` at the body's center of mass.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_apply_central_impulse:
- .. rst-class:: classref-method
- void **body_apply_central_impulse** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` impulse **)**
- Applies a directional impulse without affecting rotation.
- 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).
- This is equivalent to using :ref:`body_apply_impulse<class_PhysicsServer2D_method_body_apply_impulse>` at the body's center of mass.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_apply_force:
- .. rst-class:: classref-method
- void **body_apply_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force, :ref:`Vector2<class_Vector2>` position=Vector2(0, 0) **)**
- Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update.
- \ ``position`` is the offset from the body origin in global coordinates.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_apply_impulse:
- .. rst-class:: classref-method
- void **body_apply_impulse** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` impulse, :ref:`Vector2<class_Vector2>` position=Vector2(0, 0) **)**
- Applies a positioned impulse to the body.
- 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).
- \ ``position`` is the offset from the body origin in global coordinates.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_apply_torque:
- .. rst-class:: classref-method
- void **body_apply_torque** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)**
- Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_apply_torque_impulse:
- .. rst-class:: classref-method
- void **body_apply_torque_impulse** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` impulse **)**
- Applies a rotational impulse to the body without affecting the position.
- 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).
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_attach_canvas_instance_id:
- .. rst-class:: classref-method
- void **body_attach_canvas_instance_id** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_attach_object_instance_id:
- .. rst-class:: classref-method
- void **body_attach_object_instance_id** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)**
- Assigns the area to a descendant of :ref:`Object<class_Object>`, so it can exist in the node tree.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_clear_shapes:
- .. rst-class:: classref-method
- void **body_clear_shapes** **(** :ref:`RID<class_RID>` body **)**
- Removes all shapes from a body.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **body_create** **(** **)**
- Creates a physics body.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_get_canvas_instance_id:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **body_get_canvas_instance_id** **(** :ref:`RID<class_RID>` body **)** |const|
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_get_collision_layer:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **body_get_collision_layer** **(** :ref:`RID<class_RID>` body **)** |const|
- Returns the physics layer or layers a body belongs to.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_get_collision_mask:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **body_get_collision_mask** **(** :ref:`RID<class_RID>` body **)** |const|
- Returns the physics layer or layers a body can collide with.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_get_collision_priority:
- .. rst-class:: classref-method
- :ref:`float<class_float>` **body_get_collision_priority** **(** :ref:`RID<class_RID>` body **)** |const|
- Returns the body's collision priority.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_get_constant_force:
- .. rst-class:: classref-method
- :ref:`Vector2<class_Vector2>` **body_get_constant_force** **(** :ref:`RID<class_RID>` body **)** |const|
- Returns the body's total constant positional forces applied during each physics update.
- See :ref:`body_add_constant_force<class_PhysicsServer2D_method_body_add_constant_force>` and :ref:`body_add_constant_central_force<class_PhysicsServer2D_method_body_add_constant_central_force>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_get_constant_torque:
- .. rst-class:: classref-method
- :ref:`float<class_float>` **body_get_constant_torque** **(** :ref:`RID<class_RID>` body **)** |const|
- Returns the body's total constant rotational forces applied during each physics update.
- See :ref:`body_add_constant_torque<class_PhysicsServer2D_method_body_add_constant_torque>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_get_continuous_collision_detection_mode:
- .. rst-class:: classref-method
- :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` **body_get_continuous_collision_detection_mode** **(** :ref:`RID<class_RID>` body **)** |const|
- Returns the continuous collision detection mode.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_get_direct_state:
- .. rst-class:: classref-method
- :ref:`PhysicsDirectBodyState2D<class_PhysicsDirectBodyState2D>` **body_get_direct_state** **(** :ref:`RID<class_RID>` body **)**
- Returns the :ref:`PhysicsDirectBodyState2D<class_PhysicsDirectBodyState2D>` of the body. Returns ``null`` if the body is destroyed or removed from the physics space.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_get_max_contacts_reported:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **body_get_max_contacts_reported** **(** :ref:`RID<class_RID>` body **)** |const|
- Returns the maximum contacts that can be reported. See :ref:`body_set_max_contacts_reported<class_PhysicsServer2D_method_body_set_max_contacts_reported>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_get_mode:
- .. rst-class:: classref-method
- :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` **body_get_mode** **(** :ref:`RID<class_RID>` body **)** |const|
- Returns the body mode.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_get_object_instance_id:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **body_get_object_instance_id** **(** :ref:`RID<class_RID>` body **)** |const|
- Gets the instance ID of the object the area is assigned to.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_get_param:
- .. rst-class:: classref-method
- :ref:`Variant<class_Variant>` **body_get_param** **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` param **)** |const|
- Returns the value of a body parameter. See :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` for a list of available parameters.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_get_shape:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **body_get_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |const|
- Returns the :ref:`RID<class_RID>` of the nth shape of a body.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_get_shape_count:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **body_get_shape_count** **(** :ref:`RID<class_RID>` body **)** |const|
- Returns the number of shapes assigned to a body.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_get_shape_transform:
- .. rst-class:: classref-method
- :ref:`Transform2D<class_Transform2D>` **body_get_shape_transform** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |const|
- Returns the transform matrix of a body shape.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_get_space:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **body_get_space** **(** :ref:`RID<class_RID>` body **)** |const|
- Returns the :ref:`RID<class_RID>` of the space assigned to a body.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_get_state:
- .. rst-class:: classref-method
- :ref:`Variant<class_Variant>` **body_get_state** **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_PhysicsServer2D_BodyState>` state **)** |const|
- Returns a body state.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_is_omitting_force_integration:
- .. rst-class:: classref-method
- :ref:`bool<class_bool>` **body_is_omitting_force_integration** **(** :ref:`RID<class_RID>` body **)** |const|
- Returns whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback<class_PhysicsServer2D_method_body_set_force_integration_callback>`).
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_remove_collision_exception:
- .. rst-class:: classref-method
- void **body_remove_collision_exception** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)**
- Removes a body from the list of bodies exempt from collisions.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_remove_shape:
- .. rst-class:: classref-method
- void **body_remove_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)**
- Removes a shape from a body. The shape is not deleted, so it can be reused afterwards.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_reset_mass_properties:
- .. rst-class:: classref-method
- void **body_reset_mass_properties** **(** :ref:`RID<class_RID>` body **)**
- Restores the default inertia and center of mass based on shapes to cancel any custom values previously set using :ref:`body_set_param<class_PhysicsServer2D_method_body_set_param>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_set_axis_velocity:
- .. rst-class:: classref-method
- void **body_set_axis_velocity** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` axis_velocity **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_set_collision_layer:
- .. rst-class:: classref-method
- void **body_set_collision_layer** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` layer **)**
- Sets the physics layer or layers a body belongs to.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_set_collision_mask:
- .. rst-class:: classref-method
- void **body_set_collision_mask** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` mask **)**
- Sets the physics layer or layers a body can collide with.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_set_collision_priority:
- .. rst-class:: classref-method
- void **body_set_collision_priority** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` priority **)**
- Sets the body's collision priority.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_set_constant_force:
- .. rst-class:: classref-method
- void **body_set_constant_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)**
- Sets the body's total constant positional forces applied during each physics update.
- See :ref:`body_add_constant_force<class_PhysicsServer2D_method_body_add_constant_force>` and :ref:`body_add_constant_central_force<class_PhysicsServer2D_method_body_add_constant_central_force>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_set_constant_torque:
- .. rst-class:: classref-method
- void **body_set_constant_torque** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)**
- Sets the body's total constant rotational forces applied during each physics update.
- See :ref:`body_add_constant_torque<class_PhysicsServer2D_method_body_add_constant_torque>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_set_continuous_collision_detection_mode:
- .. rst-class:: classref-method
- void **body_set_continuous_collision_detection_mode** **(** :ref:`RID<class_RID>` body, :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` mode **)**
- Sets the continuous collision detection mode using one of the :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` constants.
- Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_set_force_integration_callback:
- .. rst-class:: classref-method
- void **body_set_force_integration_callback** **(** :ref:`RID<class_RID>` body, :ref:`Callable<class_Callable>` callable, :ref:`Variant<class_Variant>` userdata=null **)**
- Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force_integration<class_PhysicsServer2D_method_body_set_omit_force_integration>`).
- The force integration function takes 2 arguments:
- \ ``state:`` :ref:`PhysicsDirectBodyState2D<class_PhysicsDirectBodyState2D>` used to retrieve and modify the body's state.
- \ ``userdata:`` Optional user data, if it was passed when calling ``body_set_force_integration_callback``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_set_max_contacts_reported:
- .. rst-class:: classref-method
- void **body_set_max_contacts_reported** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` amount **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_set_mode:
- .. rst-class:: classref-method
- void **body_set_mode** **(** :ref:`RID<class_RID>` body, :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` mode **)**
- Sets the body mode using one of the :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` constants.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_set_omit_force_integration:
- .. rst-class:: classref-method
- void **body_set_omit_force_integration** **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)**
- Sets whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback<class_PhysicsServer2D_method_body_set_force_integration_callback>`).
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_set_param:
- .. rst-class:: classref-method
- void **body_set_param** **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` param, :ref:`Variant<class_Variant>` value **)**
- Sets a body parameter. See :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` for a list of available parameters.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_set_shape:
- .. rst-class:: classref-method
- void **body_set_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)**
- Substitutes a given body shape by another. The old shape is selected by its index, the new one by its :ref:`RID<class_RID>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_set_shape_as_one_way_collision:
- .. rst-class:: classref-method
- void **body_set_shape_as_one_way_collision** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` margin **)**
- Enables one way collision on body if ``enable`` is ``true``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_set_shape_disabled:
- .. rst-class:: classref-method
- void **body_set_shape_disabled** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)**
- Disables shape in body if ``disabled`` is ``true``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_set_shape_transform:
- .. rst-class:: classref-method
- void **body_set_shape_transform** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_Transform2D>` transform **)**
- Sets the transform matrix for a body shape.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_set_space:
- .. rst-class:: classref-method
- void **body_set_space** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` space **)**
- Assigns a space to the body (see :ref:`space_create<class_PhysicsServer2D_method_space_create>`).
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_set_state:
- .. rst-class:: classref-method
- void **body_set_state** **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_PhysicsServer2D_BodyState>` state, :ref:`Variant<class_Variant>` value **)**
- Sets a body state using one of the :ref:`BodyState<enum_PhysicsServer2D_BodyState>` constants.
- Note that the method doesn't take effect immediately. The state will change on the next physics frame.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_body_test_motion:
- .. rst-class:: classref-method
- :ref:`bool<class_bool>` **body_test_motion** **(** :ref:`RID<class_RID>` body, :ref:`PhysicsTestMotionParameters2D<class_PhysicsTestMotionParameters2D>` parameters, :ref:`PhysicsTestMotionResult2D<class_PhysicsTestMotionResult2D>` result=null **)**
- Returns ``true`` if a collision would result from moving along a motion vector from a given point in space. :ref:`PhysicsTestMotionParameters2D<class_PhysicsTestMotionParameters2D>` is passed to set motion parameters. :ref:`PhysicsTestMotionResult2D<class_PhysicsTestMotionResult2D>` can be passed to return additional information.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_capsule_shape_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **capsule_shape_create** **(** **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_circle_shape_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **circle_shape_create** **(** **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_concave_polygon_shape_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **concave_polygon_shape_create** **(** **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_convex_polygon_shape_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **convex_polygon_shape_create** **(** **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_damped_spring_joint_get_param:
- .. rst-class:: classref-method
- :ref:`float<class_float>` **damped_spring_joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` param **)** |const|
- Returns the value of a damped spring joint parameter. See :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` for a list of available parameters.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_damped_spring_joint_set_param:
- .. rst-class:: classref-method
- void **damped_spring_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` param, :ref:`float<class_float>` value **)**
- Sets a damped spring joint parameter. See :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` for a list of available parameters.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_free_rid:
- .. rst-class:: classref-method
- void **free_rid** **(** :ref:`RID<class_RID>` rid **)**
- Destroys any of the objects created by PhysicsServer2D. If the :ref:`RID<class_RID>` passed is not one of the objects that can be created by PhysicsServer2D, an error will be sent to the console.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_get_process_info:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **get_process_info** **(** :ref:`ProcessInfo<enum_PhysicsServer2D_ProcessInfo>` process_info **)**
- Returns information about the current state of the 2D physics engine. See :ref:`ProcessInfo<enum_PhysicsServer2D_ProcessInfo>` for a list of available states.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_joint_clear:
- .. rst-class:: classref-method
- void **joint_clear** **(** :ref:`RID<class_RID>` joint **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_joint_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **joint_create** **(** **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_joint_disable_collisions_between_bodies:
- .. rst-class:: classref-method
- void **joint_disable_collisions_between_bodies** **(** :ref:`RID<class_RID>` joint, :ref:`bool<class_bool>` disable **)**
- Sets whether the bodies attached to the :ref:`Joint2D<class_Joint2D>` will collide with each other.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_joint_get_param:
- .. rst-class:: classref-method
- :ref:`float<class_float>` **joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_PhysicsServer2D_JointParam>` param **)** |const|
- Returns the value of a joint parameter.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_joint_get_type:
- .. rst-class:: classref-method
- :ref:`JointType<enum_PhysicsServer2D_JointType>` **joint_get_type** **(** :ref:`RID<class_RID>` joint **)** |const|
- Returns a joint's type (see :ref:`JointType<enum_PhysicsServer2D_JointType>`).
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_joint_is_disabled_collisions_between_bodies:
- .. rst-class:: classref-method
- :ref:`bool<class_bool>` **joint_is_disabled_collisions_between_bodies** **(** :ref:`RID<class_RID>` joint **)** |const|
- Returns whether the bodies attached to the :ref:`Joint2D<class_Joint2D>` will collide with each other.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_joint_make_damped_spring:
- .. rst-class:: classref-method
- void **joint_make_damped_spring** **(** :ref:`RID<class_RID>` joint, :ref:`Vector2<class_Vector2>` anchor_a, :ref:`Vector2<class_Vector2>` anchor_b, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_joint_make_groove:
- .. rst-class:: classref-method
- void **joint_make_groove** **(** :ref:`RID<class_RID>` joint, :ref:`Vector2<class_Vector2>` groove1_a, :ref:`Vector2<class_Vector2>` groove2_a, :ref:`Vector2<class_Vector2>` anchor_b, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_joint_make_pin:
- .. rst-class:: classref-method
- void **joint_make_pin** **(** :ref:`RID<class_RID>` joint, :ref:`Vector2<class_Vector2>` anchor, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_joint_set_param:
- .. rst-class:: classref-method
- void **joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_PhysicsServer2D_JointParam>` param, :ref:`float<class_float>` value **)**
- Sets a joint parameter. See :ref:`JointParam<enum_PhysicsServer2D_JointParam>` for a list of available parameters.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_rectangle_shape_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **rectangle_shape_create** **(** **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_segment_shape_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **segment_shape_create** **(** **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_separation_ray_shape_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **separation_ray_shape_create** **(** **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_set_active:
- .. rst-class:: classref-method
- void **set_active** **(** :ref:`bool<class_bool>` active **)**
- Activates or deactivates the 2D physics engine.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_shape_get_data:
- .. rst-class:: classref-method
- :ref:`Variant<class_Variant>` **shape_get_data** **(** :ref:`RID<class_RID>` shape **)** |const|
- Returns the shape data.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_shape_get_type:
- .. rst-class:: classref-method
- :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **shape_get_type** **(** :ref:`RID<class_RID>` shape **)** |const|
- Returns a shape's type (see :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>`).
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_shape_set_data:
- .. rst-class:: classref-method
- void **shape_set_data** **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_Variant>` data **)**
- Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created :ref:`shape_get_type<class_PhysicsServer2D_method_shape_get_type>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_space_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **space_create** **(** **)**
- Creates a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with :ref:`area_set_space<class_PhysicsServer2D_method_area_set_space>`, or to a body with :ref:`body_set_space<class_PhysicsServer2D_method_body_set_space>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_space_get_direct_state:
- .. rst-class:: classref-method
- :ref:`PhysicsDirectSpaceState2D<class_PhysicsDirectSpaceState2D>` **space_get_direct_state** **(** :ref:`RID<class_RID>` space **)**
- Returns the state of a space, a :ref:`PhysicsDirectSpaceState2D<class_PhysicsDirectSpaceState2D>`. This object can be used to make collision/intersection queries.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_space_get_param:
- .. rst-class:: classref-method
- :ref:`float<class_float>` **space_get_param** **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` param **)** |const|
- Returns the value of a space parameter.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_space_is_active:
- .. rst-class:: classref-method
- :ref:`bool<class_bool>` **space_is_active** **(** :ref:`RID<class_RID>` space **)** |const|
- Returns whether the space is active.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_space_set_active:
- .. rst-class:: classref-method
- void **space_set_active** **(** :ref:`RID<class_RID>` space, :ref:`bool<class_bool>` active **)**
- Marks a space as active. It will not have an effect, unless it is assigned to an area or body.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_space_set_param:
- .. rst-class:: classref-method
- void **space_set_param** **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` param, :ref:`float<class_float>` value **)**
- Sets the value for a space parameter. See :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` for a list of available parameters.
- .. rst-class:: classref-item-separator
- ----
- .. _class_PhysicsServer2D_method_world_boundary_shape_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **world_boundary_shape_create** **(** **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|