| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138 |
- :github_url: hide
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the Physics2DServer.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_Physics2DServer:
- Physics2DServer
- ===============
- **Inherits:** :ref:`Object<class_Object>`
- **Inherited By:** :ref:`Physics2DServerSW<class_Physics2DServerSW>`
- **Category:** Core
- Brief Description
- -----------------
- Server interface for low-level 2D physics access.
- Methods
- -------
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_add_shape<class_Physics2DServer_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_Physics2DServer_method_area_attach_canvas_instance_id>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_attach_object_instance_id<class_Physics2DServer_method_area_attach_object_instance_id>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_clear_shapes<class_Physics2DServer_method_area_clear_shapes>` **(** :ref:`RID<class_RID>` area **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`area_create<class_Physics2DServer_method_area_create>` **(** **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`area_get_canvas_instance_id<class_Physics2DServer_method_area_get_canvas_instance_id>` **(** :ref:`RID<class_RID>` area **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`area_get_object_instance_id<class_Physics2DServer_method_area_get_object_instance_id>` **(** :ref:`RID<class_RID>` area **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Variant<class_Variant>` | :ref:`area_get_param<class_Physics2DServer_method_area_get_param>` **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` param **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`area_get_shape<class_Physics2DServer_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_Physics2DServer_method_area_get_shape_count>` **(** :ref:`RID<class_RID>` area **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Transform2D<class_Transform2D>` | :ref:`area_get_shape_transform<class_Physics2DServer_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_Physics2DServer_method_area_get_space>` **(** :ref:`RID<class_RID>` area **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`AreaSpaceOverrideMode<enum_Physics2DServer_AreaSpaceOverrideMode>` | :ref:`area_get_space_override_mode<class_Physics2DServer_method_area_get_space_override_mode>` **(** :ref:`RID<class_RID>` area **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Transform2D<class_Transform2D>` | :ref:`area_get_transform<class_Physics2DServer_method_area_get_transform>` **(** :ref:`RID<class_RID>` area **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_remove_shape<class_Physics2DServer_method_area_remove_shape>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_set_area_monitor_callback<class_Physics2DServer_method_area_set_area_monitor_callback>` **(** :ref:`RID<class_RID>` area, :ref:`Object<class_Object>` receiver, :ref:`String<class_String>` method **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_set_collision_layer<class_Physics2DServer_method_area_set_collision_layer>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` layer **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_set_collision_mask<class_Physics2DServer_method_area_set_collision_mask>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` mask **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_set_monitor_callback<class_Physics2DServer_method_area_set_monitor_callback>` **(** :ref:`RID<class_RID>` area, :ref:`Object<class_Object>` receiver, :ref:`String<class_String>` method **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_set_monitorable<class_Physics2DServer_method_area_set_monitorable>` **(** :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` monitorable **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_set_param<class_Physics2DServer_method_area_set_param>` **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` param, :ref:`Variant<class_Variant>` value **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_set_shape<class_Physics2DServer_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_Physics2DServer_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_Physics2DServer_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_Physics2DServer_method_area_set_space>` **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` space **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_set_space_override_mode<class_Physics2DServer_method_area_set_space_override_mode>` **(** :ref:`RID<class_RID>` area, :ref:`AreaSpaceOverrideMode<enum_Physics2DServer_AreaSpaceOverrideMode>` mode **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`area_set_transform<class_Physics2DServer_method_area_set_transform>` **(** :ref:`RID<class_RID>` area, :ref:`Transform2D<class_Transform2D>` transform **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_add_central_force<class_Physics2DServer_method_body_add_central_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_add_collision_exception<class_Physics2DServer_method_body_add_collision_exception>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_add_force<class_Physics2DServer_method_body_add_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` offset, :ref:`Vector2<class_Vector2>` force **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_add_shape<class_Physics2DServer_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_add_torque<class_Physics2DServer_method_body_add_torque>` **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_apply_central_impulse<class_Physics2DServer_method_body_apply_central_impulse>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` impulse **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_apply_impulse<class_Physics2DServer_method_body_apply_impulse>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` position, :ref:`Vector2<class_Vector2>` impulse **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_apply_torque_impulse<class_Physics2DServer_method_body_apply_torque_impulse>` **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` impulse **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_attach_canvas_instance_id<class_Physics2DServer_method_body_attach_canvas_instance_id>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_attach_object_instance_id<class_Physics2DServer_method_body_attach_object_instance_id>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_clear_shapes<class_Physics2DServer_method_body_clear_shapes>` **(** :ref:`RID<class_RID>` body **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`body_create<class_Physics2DServer_method_body_create>` **(** **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`body_get_canvas_instance_id<class_Physics2DServer_method_body_get_canvas_instance_id>` **(** :ref:`RID<class_RID>` body **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`body_get_collision_layer<class_Physics2DServer_method_body_get_collision_layer>` **(** :ref:`RID<class_RID>` body **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`body_get_collision_mask<class_Physics2DServer_method_body_get_collision_mask>` **(** :ref:`RID<class_RID>` body **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`CCDMode<enum_Physics2DServer_CCDMode>` | :ref:`body_get_continuous_collision_detection_mode<class_Physics2DServer_method_body_get_continuous_collision_detection_mode>` **(** :ref:`RID<class_RID>` body **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Physics2DDirectBodyState<class_Physics2DDirectBodyState>` | :ref:`body_get_direct_state<class_Physics2DServer_method_body_get_direct_state>` **(** :ref:`RID<class_RID>` body **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`body_get_max_contacts_reported<class_Physics2DServer_method_body_get_max_contacts_reported>` **(** :ref:`RID<class_RID>` body **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`BodyMode<enum_Physics2DServer_BodyMode>` | :ref:`body_get_mode<class_Physics2DServer_method_body_get_mode>` **(** :ref:`RID<class_RID>` body **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`body_get_object_instance_id<class_Physics2DServer_method_body_get_object_instance_id>` **(** :ref:`RID<class_RID>` body **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`body_get_param<class_Physics2DServer_method_body_get_param>` **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` param **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`body_get_shape<class_Physics2DServer_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_Physics2DServer_method_body_get_shape_count>` **(** :ref:`RID<class_RID>` body **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Variant<class_Variant>` | :ref:`body_get_shape_metadata<class_Physics2DServer_method_body_get_shape_metadata>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Transform2D<class_Transform2D>` | :ref:`body_get_shape_transform<class_Physics2DServer_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_Physics2DServer_method_body_get_space>` **(** :ref:`RID<class_RID>` body **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Variant<class_Variant>` | :ref:`body_get_state<class_Physics2DServer_method_body_get_state>` **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_Physics2DServer_BodyState>` state **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`body_is_omitting_force_integration<class_Physics2DServer_method_body_is_omitting_force_integration>` **(** :ref:`RID<class_RID>` body **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_remove_collision_exception<class_Physics2DServer_method_body_remove_collision_exception>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_remove_shape<class_Physics2DServer_method_body_remove_shape>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_axis_velocity<class_Physics2DServer_method_body_set_axis_velocity>` **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` axis_velocity **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_collision_layer<class_Physics2DServer_method_body_set_collision_layer>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` layer **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_collision_mask<class_Physics2DServer_method_body_set_collision_mask>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` mask **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_continuous_collision_detection_mode<class_Physics2DServer_method_body_set_continuous_collision_detection_mode>` **(** :ref:`RID<class_RID>` body, :ref:`CCDMode<enum_Physics2DServer_CCDMode>` mode **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_force_integration_callback<class_Physics2DServer_method_body_set_force_integration_callback>` **(** :ref:`RID<class_RID>` body, :ref:`Object<class_Object>` receiver, :ref:`String<class_String>` method, :ref:`Variant<class_Variant>` userdata=null **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_max_contacts_reported<class_Physics2DServer_method_body_set_max_contacts_reported>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` amount **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_mode<class_Physics2DServer_method_body_set_mode>` **(** :ref:`RID<class_RID>` body, :ref:`BodyMode<enum_Physics2DServer_BodyMode>` mode **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_omit_force_integration<class_Physics2DServer_method_body_set_omit_force_integration>` **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_param<class_Physics2DServer_method_body_set_param>` **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` param, :ref:`float<class_float>` value **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_shape<class_Physics2DServer_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_Physics2DServer_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_Physics2DServer_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_metadata<class_Physics2DServer_method_body_set_shape_metadata>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`Variant<class_Variant>` metadata **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_shape_transform<class_Physics2DServer_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_Physics2DServer_method_body_set_space>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` space **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`body_set_state<class_Physics2DServer_method_body_set_state>` **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_Physics2DServer_BodyState>` state, :ref:`Variant<class_Variant>` value **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`body_test_motion<class_Physics2DServer_method_body_test_motion>` **(** :ref:`RID<class_RID>` body, :ref:`Transform2D<class_Transform2D>` from, :ref:`Vector2<class_Vector2>` motion, :ref:`bool<class_bool>` infinite_inertia, :ref:`float<class_float>` margin=0.08, :ref:`Physics2DTestMotionResult<class_Physics2DTestMotionResult>` result=null **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`capsule_shape_create<class_Physics2DServer_method_capsule_shape_create>` **(** **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`circle_shape_create<class_Physics2DServer_method_circle_shape_create>` **(** **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`concave_polygon_shape_create<class_Physics2DServer_method_concave_polygon_shape_create>` **(** **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`convex_polygon_shape_create<class_Physics2DServer_method_convex_polygon_shape_create>` **(** **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`damped_spring_joint_create<class_Physics2DServer_method_damped_spring_joint_create>` **(** :ref:`Vector2<class_Vector2>` anchor_a, :ref:`Vector2<class_Vector2>` anchor_b, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`damped_string_joint_get_param<class_Physics2DServer_method_damped_string_joint_get_param>` **(** :ref:`RID<class_RID>` joint, :ref:`DampedStringParam<enum_Physics2DServer_DampedStringParam>` param **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`damped_string_joint_set_param<class_Physics2DServer_method_damped_string_joint_set_param>` **(** :ref:`RID<class_RID>` joint, :ref:`DampedStringParam<enum_Physics2DServer_DampedStringParam>` param, :ref:`float<class_float>` value **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`free_rid<class_Physics2DServer_method_free_rid>` **(** :ref:`RID<class_RID>` rid **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_process_info<class_Physics2DServer_method_get_process_info>` **(** :ref:`ProcessInfo<enum_Physics2DServer_ProcessInfo>` process_info **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`groove_joint_create<class_Physics2DServer_method_groove_joint_create>` **(** :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 **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`joint_get_param<class_Physics2DServer_method_joint_get_param>` **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_Physics2DServer_JointParam>` param **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`JointType<enum_Physics2DServer_JointType>` | :ref:`joint_get_type<class_Physics2DServer_method_joint_get_type>` **(** :ref:`RID<class_RID>` joint **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`joint_set_param<class_Physics2DServer_method_joint_set_param>` **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_Physics2DServer_JointParam>` param, :ref:`float<class_float>` value **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`line_shape_create<class_Physics2DServer_method_line_shape_create>` **(** **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`pin_joint_create<class_Physics2DServer_method_pin_joint_create>` **(** :ref:`Vector2<class_Vector2>` anchor, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`ray_shape_create<class_Physics2DServer_method_ray_shape_create>` **(** **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`rectangle_shape_create<class_Physics2DServer_method_rectangle_shape_create>` **(** **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`segment_shape_create<class_Physics2DServer_method_segment_shape_create>` **(** **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_active<class_Physics2DServer_method_set_active>` **(** :ref:`bool<class_bool>` active **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Variant<class_Variant>` | :ref:`shape_get_data<class_Physics2DServer_method_shape_get_data>` **(** :ref:`RID<class_RID>` shape **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`ShapeType<enum_Physics2DServer_ShapeType>` | :ref:`shape_get_type<class_Physics2DServer_method_shape_get_type>` **(** :ref:`RID<class_RID>` shape **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`shape_set_data<class_Physics2DServer_method_shape_set_data>` **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_Variant>` data **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`space_create<class_Physics2DServer_method_space_create>` **(** **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Physics2DDirectSpaceState<class_Physics2DDirectSpaceState>` | :ref:`space_get_direct_state<class_Physics2DServer_method_space_get_direct_state>` **(** :ref:`RID<class_RID>` space **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`space_get_param<class_Physics2DServer_method_space_get_param>` **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_Physics2DServer_SpaceParameter>` param **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`space_is_active<class_Physics2DServer_method_space_is_active>` **(** :ref:`RID<class_RID>` space **)** const |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`space_set_active<class_Physics2DServer_method_space_set_active>` **(** :ref:`RID<class_RID>` space, :ref:`bool<class_bool>` active **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`space_set_param<class_Physics2DServer_method_space_set_param>` **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_Physics2DServer_SpaceParameter>` param, :ref:`float<class_float>` value **)** |
- +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Enumerations
- ------------
- .. _enum_Physics2DServer_SpaceParameter:
- .. _class_Physics2DServer_constant_SPACE_PARAM_CONTACT_RECYCLE_RADIUS:
- .. _class_Physics2DServer_constant_SPACE_PARAM_CONTACT_MAX_SEPARATION:
- .. _class_Physics2DServer_constant_SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION:
- .. _class_Physics2DServer_constant_SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD:
- .. _class_Physics2DServer_constant_SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD:
- .. _class_Physics2DServer_constant_SPACE_PARAM_BODY_TIME_TO_SLEEP:
- .. _class_Physics2DServer_constant_SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS:
- .. _class_Physics2DServer_constant_SPACE_PARAM_TEST_MOTION_MIN_CONTACT_DEPTH:
- enum **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.
- - **SPACE_PARAM_CONTACT_MAX_SEPARATION** = **1** --- Constant to set/get the maximum distance a shape can be from another before they are considered separated.
- - **SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION** = **2** --- Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision.
- - **SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD** = **3** --- 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.
- - **SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD** = **4** --- 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.
- - **SPACE_PARAM_BODY_TIME_TO_SLEEP** = **5** --- 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.
- - **SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS** = **6** --- 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.
- - **SPACE_PARAM_TEST_MOTION_MIN_CONTACT_DEPTH** = **7**
- .. _enum_Physics2DServer_ShapeType:
- .. _class_Physics2DServer_constant_SHAPE_LINE:
- .. _class_Physics2DServer_constant_SHAPE_RAY:
- .. _class_Physics2DServer_constant_SHAPE_SEGMENT:
- .. _class_Physics2DServer_constant_SHAPE_CIRCLE:
- .. _class_Physics2DServer_constant_SHAPE_RECTANGLE:
- .. _class_Physics2DServer_constant_SHAPE_CAPSULE:
- .. _class_Physics2DServer_constant_SHAPE_CONVEX_POLYGON:
- .. _class_Physics2DServer_constant_SHAPE_CONCAVE_POLYGON:
- .. _class_Physics2DServer_constant_SHAPE_CUSTOM:
- enum **ShapeType**:
- - **SHAPE_LINE** = **0** --- This is the constant for creating line shapes. A line shape is an infinite line with an origin point, and a normal. Thus, it can be used for front/behind checks.
- - **SHAPE_RAY** = **1**
- - **SHAPE_SEGMENT** = **2** --- This is the constant for creating segment shapes. A segment shape is a line from a point A to a point B. It can be checked for intersections.
- - **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.
- - **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.
- - **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.
- - **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_Physics2DServer_method_shape_set_data>` do not verify that the points supplied form is a convex polygon.
- - **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.
- - **SHAPE_CUSTOM** = **8** --- This constant is used internally by the engine. Any attempt to create this kind of shape results in an error.
- .. _enum_Physics2DServer_AreaParameter:
- .. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY:
- .. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY_VECTOR:
- .. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY_IS_POINT:
- .. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY_DISTANCE_SCALE:
- .. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY_POINT_ATTENUATION:
- .. _class_Physics2DServer_constant_AREA_PARAM_LINEAR_DAMP:
- .. _class_Physics2DServer_constant_AREA_PARAM_ANGULAR_DAMP:
- .. _class_Physics2DServer_constant_AREA_PARAM_PRIORITY:
- enum **AreaParameter**:
- - **AREA_PARAM_GRAVITY** = **0** --- Constant to set/get gravity strength in an area.
- - **AREA_PARAM_GRAVITY_VECTOR** = **1** --- Constant to set/get gravity vector/center in an area.
- - **AREA_PARAM_GRAVITY_IS_POINT** = **2** --- Constant to set/get whether the gravity vector of an area is a direction, or a center point.
- - **AREA_PARAM_GRAVITY_DISTANCE_SCALE** = **3** --- 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.
- - **AREA_PARAM_GRAVITY_POINT_ATTENUATION** = **4** --- This constant was used to set/get the falloff factor for point gravity. It has been superseded by AREA_PARAM_GRAVITY_DISTANCE_SCALE.
- - **AREA_PARAM_LINEAR_DAMP** = **5** --- Constant to set/get the linear dampening factor of an area.
- - **AREA_PARAM_ANGULAR_DAMP** = **6** --- Constant to set/get the angular dampening factor of an area.
- - **AREA_PARAM_PRIORITY** = **7** --- Constant to set/get the priority (order of processing) of an area.
- .. _enum_Physics2DServer_AreaSpaceOverrideMode:
- .. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_DISABLED:
- .. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_COMBINE:
- .. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_COMBINE_REPLACE:
- .. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_REPLACE:
- .. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_REPLACE_COMBINE:
- enum **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.
- - **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.
- - **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.
- - **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.
- - **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.
- .. _enum_Physics2DServer_BodyMode:
- .. _class_Physics2DServer_constant_BODY_MODE_STATIC:
- .. _class_Physics2DServer_constant_BODY_MODE_KINEMATIC:
- .. _class_Physics2DServer_constant_BODY_MODE_RIGID:
- .. _class_Physics2DServer_constant_BODY_MODE_CHARACTER:
- enum **BodyMode**:
- - **BODY_MODE_STATIC** = **0** --- Constant for static bodies.
- - **BODY_MODE_KINEMATIC** = **1** --- Constant for kinematic bodies.
- - **BODY_MODE_RIGID** = **2** --- Constant for rigid bodies.
- - **BODY_MODE_CHARACTER** = **3** --- Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics.
- .. _enum_Physics2DServer_BodyParameter:
- .. _class_Physics2DServer_constant_BODY_PARAM_BOUNCE:
- .. _class_Physics2DServer_constant_BODY_PARAM_FRICTION:
- .. _class_Physics2DServer_constant_BODY_PARAM_MASS:
- .. _class_Physics2DServer_constant_BODY_PARAM_INERTIA:
- .. _class_Physics2DServer_constant_BODY_PARAM_GRAVITY_SCALE:
- .. _class_Physics2DServer_constant_BODY_PARAM_LINEAR_DAMP:
- .. _class_Physics2DServer_constant_BODY_PARAM_ANGULAR_DAMP:
- .. _class_Physics2DServer_constant_BODY_PARAM_MAX:
- enum **BodyParameter**:
- - **BODY_PARAM_BOUNCE** = **0** --- Constant to set/get a body's bounce factor.
- - **BODY_PARAM_FRICTION** = **1** --- Constant to set/get a body's friction.
- - **BODY_PARAM_MASS** = **2** --- Constant to set/get a body's mass.
- - **BODY_PARAM_INERTIA** = **3** --- Constant to set/get a body's inertia.
- - **BODY_PARAM_GRAVITY_SCALE** = **4** --- Constant to set/get a body's gravity multiplier.
- - **BODY_PARAM_LINEAR_DAMP** = **5** --- Constant to set/get a body's linear dampening factor.
- - **BODY_PARAM_ANGULAR_DAMP** = **6** --- Constant to set/get a body's angular dampening factor.
- - **BODY_PARAM_MAX** = **7** --- Represents the size of the :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` enum.
- .. _enum_Physics2DServer_BodyState:
- .. _class_Physics2DServer_constant_BODY_STATE_TRANSFORM:
- .. _class_Physics2DServer_constant_BODY_STATE_LINEAR_VELOCITY:
- .. _class_Physics2DServer_constant_BODY_STATE_ANGULAR_VELOCITY:
- .. _class_Physics2DServer_constant_BODY_STATE_SLEEPING:
- .. _class_Physics2DServer_constant_BODY_STATE_CAN_SLEEP:
- enum **BodyState**:
- - **BODY_STATE_TRANSFORM** = **0** --- Constant to set/get the current transform matrix of the body.
- - **BODY_STATE_LINEAR_VELOCITY** = **1** --- Constant to set/get the current linear velocity of the body.
- - **BODY_STATE_ANGULAR_VELOCITY** = **2** --- Constant to set/get the current angular velocity of the body.
- - **BODY_STATE_SLEEPING** = **3** --- Constant to sleep/wake up a body, or to get whether it is sleeping.
- - **BODY_STATE_CAN_SLEEP** = **4** --- Constant to set/get whether the body can sleep.
- .. _enum_Physics2DServer_JointType:
- .. _class_Physics2DServer_constant_JOINT_PIN:
- .. _class_Physics2DServer_constant_JOINT_GROOVE:
- .. _class_Physics2DServer_constant_JOINT_DAMPED_SPRING:
- enum **JointType**:
- - **JOINT_PIN** = **0** --- Constant to create pin joints.
- - **JOINT_GROOVE** = **1** --- Constant to create groove joints.
- - **JOINT_DAMPED_SPRING** = **2** --- Constant to create damped spring joints.
- .. _enum_Physics2DServer_JointParam:
- .. _class_Physics2DServer_constant_JOINT_PARAM_BIAS:
- .. _class_Physics2DServer_constant_JOINT_PARAM_MAX_BIAS:
- .. _class_Physics2DServer_constant_JOINT_PARAM_MAX_FORCE:
- enum **JointParam**:
- - **JOINT_PARAM_BIAS** = **0**
- - **JOINT_PARAM_MAX_BIAS** = **1**
- - **JOINT_PARAM_MAX_FORCE** = **2**
- .. _enum_Physics2DServer_DampedStringParam:
- .. _class_Physics2DServer_constant_DAMPED_STRING_REST_LENGTH:
- .. _class_Physics2DServer_constant_DAMPED_STRING_STIFFNESS:
- .. _class_Physics2DServer_constant_DAMPED_STRING_DAMPING:
- enum **DampedStringParam**:
- - **DAMPED_STRING_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.
- - **DAMPED_STRING_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.
- - **DAMPED_STRING_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).
- .. _enum_Physics2DServer_CCDMode:
- .. _class_Physics2DServer_constant_CCD_MODE_DISABLED:
- .. _class_Physics2DServer_constant_CCD_MODE_CAST_RAY:
- .. _class_Physics2DServer_constant_CCD_MODE_CAST_SHAPE:
- enum **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.
- - **CCD_MODE_CAST_RAY** = **1** --- Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise.
- - **CCD_MODE_CAST_SHAPE** = **2** --- Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise.
- .. _enum_Physics2DServer_AreaBodyStatus:
- .. _class_Physics2DServer_constant_AREA_BODY_ADDED:
- .. _class_Physics2DServer_constant_AREA_BODY_REMOVED:
- enum **AreaBodyStatus**:
- - **AREA_BODY_ADDED** = **0** --- The value of the first parameter and area callback function receives, when an object enters one of its shapes.
- - **AREA_BODY_REMOVED** = **1** --- The value of the first parameter and area callback function receives, when an object exits one of its shapes.
- .. _enum_Physics2DServer_ProcessInfo:
- .. _class_Physics2DServer_constant_INFO_ACTIVE_OBJECTS:
- .. _class_Physics2DServer_constant_INFO_COLLISION_PAIRS:
- .. _class_Physics2DServer_constant_INFO_ISLAND_COUNT:
- enum **ProcessInfo**:
- - **INFO_ACTIVE_OBJECTS** = **0** --- Constant to get the number of objects that are not sleeping.
- - **INFO_COLLISION_PAIRS** = **1** --- Constant to get the number of possible collisions.
- - **INFO_ISLAND_COUNT** = **2** --- Constant to get the number of space regions where a collision could occur.
- Description
- -----------
- Physics2DServer 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.
- Method Descriptions
- -------------------
- .. _class_Physics2DServer_method_area_add_shape:
- - 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.
- .. _class_Physics2DServer_method_area_attach_canvas_instance_id:
- - void **area_attach_canvas_instance_id** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)**
- .. _class_Physics2DServer_method_area_attach_object_instance_id:
- - 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.
- .. _class_Physics2DServer_method_area_clear_shapes:
- - 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.
- .. _class_Physics2DServer_method_area_create:
- - :ref:`RID<class_RID>` **area_create** **(** **)**
- Creates an :ref:`Area2D<class_Area2D>`.
- .. _class_Physics2DServer_method_area_get_canvas_instance_id:
- - :ref:`int<class_int>` **area_get_canvas_instance_id** **(** :ref:`RID<class_RID>` area **)** const
- .. _class_Physics2DServer_method_area_get_object_instance_id:
- - :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.
- .. _class_Physics2DServer_method_area_get_param:
- - :ref:`Variant<class_Variant>` **area_get_param** **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` param **)** const
- Returns an area parameter value. See :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` for a list of available parameters.
- .. _class_Physics2DServer_method_area_get_shape:
- - :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.
- .. _class_Physics2DServer_method_area_get_shape_count:
- - :ref:`int<class_int>` **area_get_shape_count** **(** :ref:`RID<class_RID>` area **)** const
- Returns the number of shapes assigned to an area.
- .. _class_Physics2DServer_method_area_get_shape_transform:
- - :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.
- .. _class_Physics2DServer_method_area_get_space:
- - :ref:`RID<class_RID>` **area_get_space** **(** :ref:`RID<class_RID>` area **)** const
- Returns the space assigned to the area.
- .. _class_Physics2DServer_method_area_get_space_override_mode:
- - :ref:`AreaSpaceOverrideMode<enum_Physics2DServer_AreaSpaceOverrideMode>` **area_get_space_override_mode** **(** :ref:`RID<class_RID>` area **)** const
- Returns the space override mode for the area.
- .. _class_Physics2DServer_method_area_get_transform:
- - :ref:`Transform2D<class_Transform2D>` **area_get_transform** **(** :ref:`RID<class_RID>` area **)** const
- Returns the transform matrix for an area.
- .. _class_Physics2DServer_method_area_remove_shape:
- - 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.
- .. _class_Physics2DServer_method_area_set_area_monitor_callback:
- - void **area_set_area_monitor_callback** **(** :ref:`RID<class_RID>` area, :ref:`Object<class_Object>` receiver, :ref:`String<class_String>` method **)**
- .. _class_Physics2DServer_method_area_set_collision_layer:
- - void **area_set_collision_layer** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` layer **)**
- Assigns the area to one or many physics layers.
- .. _class_Physics2DServer_method_area_set_collision_mask:
- - void **area_set_collision_mask** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` mask **)**
- Sets which physics layers the area will monitor.
- .. _class_Physics2DServer_method_area_set_monitor_callback:
- - void **area_set_monitor_callback** **(** :ref:`RID<class_RID>` area, :ref:`Object<class_Object>` receiver, :ref:`String<class_String>` method **)**
- 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: AREA_BODY_ADDED or 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.
- .. _class_Physics2DServer_method_area_set_monitorable:
- - void **area_set_monitorable** **(** :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` monitorable **)**
- .. _class_Physics2DServer_method_area_set_param:
- - void **area_set_param** **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` param, :ref:`Variant<class_Variant>` value **)**
- Sets the value for an area parameter. See :ref:`AreaParameter<enum_Physics2DServer_AreaParameter>` for a list of available parameters.
- .. _class_Physics2DServer_method_area_set_shape:
- - 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>`.
- .. _class_Physics2DServer_method_area_set_shape_disabled:
- - 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.
- .. _class_Physics2DServer_method_area_set_shape_transform:
- - 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.
- .. _class_Physics2DServer_method_area_set_space:
- - void **area_set_space** **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` space **)**
- Assigns a space to the area.
- .. _class_Physics2DServer_method_area_set_space_override_mode:
- - void **area_set_space_override_mode** **(** :ref:`RID<class_RID>` area, :ref:`AreaSpaceOverrideMode<enum_Physics2DServer_AreaSpaceOverrideMode>` mode **)**
- Sets the space override mode for the area. See :ref:`AreaSpaceOverrideMode<enum_Physics2DServer_AreaSpaceOverrideMode>` for a list of available modes.
- .. _class_Physics2DServer_method_area_set_transform:
- - void **area_set_transform** **(** :ref:`RID<class_RID>` area, :ref:`Transform2D<class_Transform2D>` transform **)**
- Sets the transform matrix for an area.
- .. _class_Physics2DServer_method_body_add_central_force:
- - void **body_add_central_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)**
- .. _class_Physics2DServer_method_body_add_collision_exception:
- - 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.
- .. _class_Physics2DServer_method_body_add_force:
- - void **body_add_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` offset, :ref:`Vector2<class_Vector2>` force **)**
- Adds a positioned force to the applied force and torque. As with :ref:`body_apply_impulse<class_Physics2DServer_method_body_apply_impulse>`, both the force and the offset from the body origin are in global coordinates. A force differs from an impulse in that, while the two are forces, the impulse clears itself after being applied.
- .. _class_Physics2DServer_method_body_add_shape:
- - 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.
- .. _class_Physics2DServer_method_body_add_torque:
- - void **body_add_torque** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)**
- .. _class_Physics2DServer_method_body_apply_central_impulse:
- - void **body_apply_central_impulse** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` impulse **)**
- .. _class_Physics2DServer_method_body_apply_impulse:
- - void **body_apply_impulse** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` position, :ref:`Vector2<class_Vector2>` impulse **)**
- Adds a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates.
- .. _class_Physics2DServer_method_body_apply_torque_impulse:
- - void **body_apply_torque_impulse** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` impulse **)**
- .. _class_Physics2DServer_method_body_attach_canvas_instance_id:
- - void **body_attach_canvas_instance_id** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)**
- .. _class_Physics2DServer_method_body_attach_object_instance_id:
- - 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.
- .. _class_Physics2DServer_method_body_clear_shapes:
- - void **body_clear_shapes** **(** :ref:`RID<class_RID>` body **)**
- Removes all shapes from a body.
- .. _class_Physics2DServer_method_body_create:
- - :ref:`RID<class_RID>` **body_create** **(** **)**
- Creates a physics body.
- .. _class_Physics2DServer_method_body_get_canvas_instance_id:
- - :ref:`int<class_int>` **body_get_canvas_instance_id** **(** :ref:`RID<class_RID>` body **)** const
- .. _class_Physics2DServer_method_body_get_collision_layer:
- - :ref:`int<class_int>` **body_get_collision_layer** **(** :ref:`RID<class_RID>` body **)** const
- Returns the physics layer or layers a body belongs to.
- .. _class_Physics2DServer_method_body_get_collision_mask:
- - :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.
- .. _class_Physics2DServer_method_body_get_continuous_collision_detection_mode:
- - :ref:`CCDMode<enum_Physics2DServer_CCDMode>` **body_get_continuous_collision_detection_mode** **(** :ref:`RID<class_RID>` body **)** const
- Returns the continuous collision detection mode.
- .. _class_Physics2DServer_method_body_get_direct_state:
- - :ref:`Physics2DDirectBodyState<class_Physics2DDirectBodyState>` **body_get_direct_state** **(** :ref:`RID<class_RID>` body **)**
- Returns the :ref:`Physics2DDirectBodyState<class_Physics2DDirectBodyState>` of the body.
- .. _class_Physics2DServer_method_body_get_max_contacts_reported:
- - :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_Physics2DServer_method_body_set_max_contacts_reported>`.
- .. _class_Physics2DServer_method_body_get_mode:
- - :ref:`BodyMode<enum_Physics2DServer_BodyMode>` **body_get_mode** **(** :ref:`RID<class_RID>` body **)** const
- Returns the body mode.
- .. _class_Physics2DServer_method_body_get_object_instance_id:
- - :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.
- .. _class_Physics2DServer_method_body_get_param:
- - :ref:`float<class_float>` **body_get_param** **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` param **)** const
- Returns the value of a body parameter. See :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` for a list of available parameters.
- .. _class_Physics2DServer_method_body_get_shape:
- - :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.
- .. _class_Physics2DServer_method_body_get_shape_count:
- - :ref:`int<class_int>` **body_get_shape_count** **(** :ref:`RID<class_RID>` body **)** const
- Returns the number of shapes assigned to a body.
- .. _class_Physics2DServer_method_body_get_shape_metadata:
- - :ref:`Variant<class_Variant>` **body_get_shape_metadata** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** const
- Returns the metadata of a shape of a body.
- .. _class_Physics2DServer_method_body_get_shape_transform:
- - :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.
- .. _class_Physics2DServer_method_body_get_space:
- - :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.
- .. _class_Physics2DServer_method_body_get_state:
- - :ref:`Variant<class_Variant>` **body_get_state** **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_Physics2DServer_BodyState>` state **)** const
- Returns a body state.
- .. _class_Physics2DServer_method_body_is_omitting_force_integration:
- - :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_Physics2DServer_method_body_set_force_integration_callback>`).
- .. _class_Physics2DServer_method_body_remove_collision_exception:
- - 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.
- .. _class_Physics2DServer_method_body_remove_shape:
- - 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.
- .. _class_Physics2DServer_method_body_set_axis_velocity:
- - 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.
- .. _class_Physics2DServer_method_body_set_collision_layer:
- - 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.
- .. _class_Physics2DServer_method_body_set_collision_mask:
- - 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.
- .. _class_Physics2DServer_method_body_set_continuous_collision_detection_mode:
- - void **body_set_continuous_collision_detection_mode** **(** :ref:`RID<class_RID>` body, :ref:`CCDMode<enum_Physics2DServer_CCDMode>` mode **)**
- Sets the continuous collision detection mode using one of the :ref:`CCDMode<enum_Physics2DServer_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.
- .. _class_Physics2DServer_method_body_set_force_integration_callback:
- - void **body_set_force_integration_callback** **(** :ref:`RID<class_RID>` body, :ref:`Object<class_Object>` receiver, :ref:`String<class_String>` method, :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_Physics2DServer_method_body_set_omit_force_integration>`).
- .. _class_Physics2DServer_method_body_set_max_contacts_reported:
- - 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 amount of contacts reported to a number greater than 0.
- .. _class_Physics2DServer_method_body_set_mode:
- - void **body_set_mode** **(** :ref:`RID<class_RID>` body, :ref:`BodyMode<enum_Physics2DServer_BodyMode>` mode **)**
- Sets the body mode using one of the :ref:`BodyMode<enum_Physics2DServer_BodyMode>` constants.
- .. _class_Physics2DServer_method_body_set_omit_force_integration:
- - 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_Physics2DServer_method_body_set_force_integration_callback>`).
- .. _class_Physics2DServer_method_body_set_param:
- - void **body_set_param** **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` param, :ref:`float<class_float>` value **)**
- Sets a body parameter. See :ref:`BodyParameter<enum_Physics2DServer_BodyParameter>` for a list of available parameters.
- .. _class_Physics2DServer_method_body_set_shape:
- - 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>`.
- .. _class_Physics2DServer_method_body_set_shape_as_one_way_collision:
- - 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``.
- .. _class_Physics2DServer_method_body_set_shape_disabled:
- - 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 ``disable`` is ``true``.
- .. _class_Physics2DServer_method_body_set_shape_metadata:
- - void **body_set_shape_metadata** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`Variant<class_Variant>` metadata **)**
- Sets metadata of a shape within a body. This metadata is different from :ref:`Object.set_meta<class_Object_method_set_meta>`, and can be retrieved on shape queries.
- .. _class_Physics2DServer_method_body_set_shape_transform:
- - 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.
- .. _class_Physics2DServer_method_body_set_space:
- - 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_Physics2DServer_method_space_create>`).
- .. _class_Physics2DServer_method_body_set_state:
- - void **body_set_state** **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_Physics2DServer_BodyState>` state, :ref:`Variant<class_Variant>` value **)**
- Sets a body state using one of the :ref:`BodyState<enum_Physics2DServer_BodyState>` constants.
- .. _class_Physics2DServer_method_body_test_motion:
- - :ref:`bool<class_bool>` **body_test_motion** **(** :ref:`RID<class_RID>` body, :ref:`Transform2D<class_Transform2D>` from, :ref:`Vector2<class_Vector2>` motion, :ref:`bool<class_bool>` infinite_inertia, :ref:`float<class_float>` margin=0.08, :ref:`Physics2DTestMotionResult<class_Physics2DTestMotionResult>` result=null **)**
- Returns whether a body can move from a given point in a given direction. Apart from the boolean return value, a :ref:`Physics2DTestMotionResult<class_Physics2DTestMotionResult>` can be passed to return additional information in.
- .. _class_Physics2DServer_method_capsule_shape_create:
- - :ref:`RID<class_RID>` **capsule_shape_create** **(** **)**
- .. _class_Physics2DServer_method_circle_shape_create:
- - :ref:`RID<class_RID>` **circle_shape_create** **(** **)**
- .. _class_Physics2DServer_method_concave_polygon_shape_create:
- - :ref:`RID<class_RID>` **concave_polygon_shape_create** **(** **)**
- .. _class_Physics2DServer_method_convex_polygon_shape_create:
- - :ref:`RID<class_RID>` **convex_polygon_shape_create** **(** **)**
- .. _class_Physics2DServer_method_damped_spring_joint_create:
- - :ref:`RID<class_RID>` **damped_spring_joint_create** **(** :ref:`Vector2<class_Vector2>` anchor_a, :ref:`Vector2<class_Vector2>` anchor_b, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)**
- Creates a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself.
- .. _class_Physics2DServer_method_damped_string_joint_get_param:
- - :ref:`float<class_float>` **damped_string_joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`DampedStringParam<enum_Physics2DServer_DampedStringParam>` param **)** const
- Returns the value of a damped spring joint parameter.
- .. _class_Physics2DServer_method_damped_string_joint_set_param:
- - void **damped_string_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`DampedStringParam<enum_Physics2DServer_DampedStringParam>` param, :ref:`float<class_float>` value **)**
- Sets a damped spring joint parameter. See :ref:`DampedStringParam<enum_Physics2DServer_DampedStringParam>` for a list of available parameters.
- .. _class_Physics2DServer_method_free_rid:
- - void **free_rid** **(** :ref:`RID<class_RID>` rid **)**
- Destroys any of the objects created by Physics2DServer. If the :ref:`RID<class_RID>` passed is not one of the objects that can be created by Physics2DServer, an error will be sent to the console.
- .. _class_Physics2DServer_method_get_process_info:
- - :ref:`int<class_int>` **get_process_info** **(** :ref:`ProcessInfo<enum_Physics2DServer_ProcessInfo>` process_info **)**
- Returns information about the current state of the 2D physics engine. See :ref:`ProcessInfo<enum_Physics2DServer_ProcessInfo>` for a list of available states.
- .. _class_Physics2DServer_method_groove_joint_create:
- - :ref:`RID<class_RID>` **groove_joint_create** **(** :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 **)**
- Creates a groove joint between two bodies. If not specified, the bodies are assumed to be the joint itself.
- .. _class_Physics2DServer_method_joint_get_param:
- - :ref:`float<class_float>` **joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_Physics2DServer_JointParam>` param **)** const
- Returns the value of a joint parameter.
- .. _class_Physics2DServer_method_joint_get_type:
- - :ref:`JointType<enum_Physics2DServer_JointType>` **joint_get_type** **(** :ref:`RID<class_RID>` joint **)** const
- Returns a joint's type (see :ref:`JointType<enum_Physics2DServer_JointType>`).
- .. _class_Physics2DServer_method_joint_set_param:
- - void **joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_Physics2DServer_JointParam>` param, :ref:`float<class_float>` value **)**
- Sets a joint parameter. See :ref:`JointParam<enum_Physics2DServer_JointParam>` for a list of available parameters.
- .. _class_Physics2DServer_method_line_shape_create:
- - :ref:`RID<class_RID>` **line_shape_create** **(** **)**
- .. _class_Physics2DServer_method_pin_joint_create:
- - :ref:`RID<class_RID>` **pin_joint_create** **(** :ref:`Vector2<class_Vector2>` anchor, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)**
- Creates a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself.
- .. _class_Physics2DServer_method_ray_shape_create:
- - :ref:`RID<class_RID>` **ray_shape_create** **(** **)**
- .. _class_Physics2DServer_method_rectangle_shape_create:
- - :ref:`RID<class_RID>` **rectangle_shape_create** **(** **)**
- .. _class_Physics2DServer_method_segment_shape_create:
- - :ref:`RID<class_RID>` **segment_shape_create** **(** **)**
- .. _class_Physics2DServer_method_set_active:
- - void **set_active** **(** :ref:`bool<class_bool>` active **)**
- Activates or deactivates the 2D physics engine.
- .. _class_Physics2DServer_method_shape_get_data:
- - :ref:`Variant<class_Variant>` **shape_get_data** **(** :ref:`RID<class_RID>` shape **)** const
- Returns the shape data.
- .. _class_Physics2DServer_method_shape_get_type:
- - :ref:`ShapeType<enum_Physics2DServer_ShapeType>` **shape_get_type** **(** :ref:`RID<class_RID>` shape **)** const
- Returns a shape's type (see :ref:`ShapeType<enum_Physics2DServer_ShapeType>`).
- .. _class_Physics2DServer_method_shape_set_data:
- - 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_Physics2DServer_method_shape_get_type>`.
- .. _class_Physics2DServer_method_space_create:
- - :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_Physics2DServer_method_area_set_space>`, or to a body with :ref:`body_set_space<class_Physics2DServer_method_body_set_space>`.
- .. _class_Physics2DServer_method_space_get_direct_state:
- - :ref:`Physics2DDirectSpaceState<class_Physics2DDirectSpaceState>` **space_get_direct_state** **(** :ref:`RID<class_RID>` space **)**
- Returns the state of a space, a :ref:`Physics2DDirectSpaceState<class_Physics2DDirectSpaceState>`. This object can be used to make collision/intersection queries.
- .. _class_Physics2DServer_method_space_get_param:
- - :ref:`float<class_float>` **space_get_param** **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_Physics2DServer_SpaceParameter>` param **)** const
- Returns the value of a space parameter.
- .. _class_Physics2DServer_method_space_is_active:
- - :ref:`bool<class_bool>` **space_is_active** **(** :ref:`RID<class_RID>` space **)** const
- Returns whether the space is active.
- .. _class_Physics2DServer_method_space_set_active:
- - 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.
- .. _class_Physics2DServer_method_space_set_param:
- - void **space_set_param** **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_Physics2DServer_SpaceParameter>` param, :ref:`float<class_float>` value **)**
- Sets the value for a space parameter. See :ref:`SpaceParameter<enum_Physics2DServer_SpaceParameter>` for a list of available parameters.
|
