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