| github_url: | hide |
|---|
Inherits: :ref:`Object<class_Object>`
Inherited By: :ref:`PhysicsServer2DExtension<class_PhysicsServer2DExtension>`
A server interface for low-level 2D physics access.
.. rst-class:: classref-introduction-group
PhysicsServer2D is the server responsible for all 2D physics. It can directly create and manipulate all physics objects:
- A space is a self-contained world for a physics simulation. It contains bodies, areas, and joints. Its state can be queried for collision and intersection information, and several parameters of the simulation can be modified.
- A shape is a geometric shape such as a circle, a rectangle, a capsule, or a polygon. It can be used for collision detection by adding it to a body/area, possibly with an extra transformation relative to the body/area's origin. Bodies/areas can have multiple (transformed) shapes added to them, and a single shape can be added to bodies/areas multiple times with different local transformations.
- A body is a physical object which can be in static, kinematic, or rigid mode. Its state (such as position and velocity) can be queried and updated. A force integration callback can be set to customize the body's physics.
- An area is a region in space which can be used to detect bodies and areas entering and exiting it. A body monitoring callback can be set to report entering/exiting body shapes, and similarly an area monitoring callback can be set. Gravity and damping can be overridden within the area by setting area parameters.
- A joint is a constraint, either between two bodies or on one body relative to a point. Parameters such as the joint bias and the rest length of a spring joint can be adjusted.
Physics objects in PhysicsServer2D may be created and manipulated independently; they do not have to be tied to nodes in the scene tree.
Note: All the 2D physics nodes use the physics server internally. Adding a physics node to the scene tree will cause a corresponding physics object to be created in the physics server. A rigid body node registers a callback that updates the node's transform with the transform of the respective body object in the physics server (every physics update). An area node registers a callback to inform the area node about overlaps with the respective area object in the physics server. The raycast node queries the direct state of the relevant space in the physics server.
.. rst-class:: classref-reftable-group
.. rst-class:: classref-section-separator
.. rst-class:: classref-descriptions-group
.. rst-class:: classref-enumeration
enum SpaceParameter:
.. rst-class:: classref-enumeration-constant
:ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` SPACE_PARAM_CONTACT_RECYCLE_RADIUS = 0
Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated. The default value of this parameter is :ref:`ProjectSettings.physics/2d/solver/contact_recycle_radius<class_ProjectSettings_property_physics/2d/solver/contact_recycle_radius>`.
.. rst-class:: classref-enumeration-constant
:ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` SPACE_PARAM_CONTACT_MAX_SEPARATION = 1
Constant to set/get the maximum distance a shape can be from another before they are considered separated and the contact is discarded. The default value of this parameter is :ref:`ProjectSettings.physics/2d/solver/contact_max_separation<class_ProjectSettings_property_physics/2d/solver/contact_max_separation>`.
.. rst-class:: classref-enumeration-constant
:ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION = 2
Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision. The default value of this parameter is :ref:`ProjectSettings.physics/2d/solver/contact_max_allowed_penetration<class_ProjectSettings_property_physics/2d/solver/contact_max_allowed_penetration>`.
.. rst-class:: classref-enumeration-constant
:ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` SPACE_PARAM_CONTACT_DEFAULT_BIAS = 3
Constant to set/get the default solver bias for all physics contacts. A solver bias is a factor controlling how much two objects "rebound", after overlapping, to avoid leaving them in that state because of numerical imprecision. The default value of this parameter is :ref:`ProjectSettings.physics/2d/solver/default_contact_bias<class_ProjectSettings_property_physics/2d/solver/default_contact_bias>`.
.. rst-class:: classref-enumeration-constant
:ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD = 4
Constant to set/get the threshold linear velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given. The default value of this parameter is :ref:`ProjectSettings.physics/2d/sleep_threshold_linear<class_ProjectSettings_property_physics/2d/sleep_threshold_linear>`.
.. rst-class:: classref-enumeration-constant
:ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD = 5
Constant to set/get the threshold angular velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given. The default value of this parameter is :ref:`ProjectSettings.physics/2d/sleep_threshold_angular<class_ProjectSettings_property_physics/2d/sleep_threshold_angular>`.
.. rst-class:: classref-enumeration-constant
:ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` SPACE_PARAM_BODY_TIME_TO_SLEEP = 6
Constant to set/get the maximum time of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after this time. The default value of this parameter is :ref:`ProjectSettings.physics/2d/time_before_sleep<class_ProjectSettings_property_physics/2d/time_before_sleep>`.
.. rst-class:: classref-enumeration-constant
:ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS = 7
Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision. The default value of this parameter is :ref:`ProjectSettings.physics/2d/solver/default_constraint_bias<class_ProjectSettings_property_physics/2d/solver/default_constraint_bias>`.
.. rst-class:: classref-enumeration-constant
:ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` SPACE_PARAM_SOLVER_ITERATIONS = 8
Constant to set/get the number of solver iterations for all contacts and constraints. The greater the number of iterations, the more accurate the collisions will be. However, a greater number of iterations requires more CPU power, which can decrease performance. The default value of this parameter is :ref:`ProjectSettings.physics/2d/solver/solver_iterations<class_ProjectSettings_property_physics/2d/solver/solver_iterations>`.
.. rst-class:: classref-item-separator
.. rst-class:: classref-enumeration
enum ShapeType:
.. rst-class:: classref-enumeration-constant
:ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` SHAPE_WORLD_BOUNDARY = 0
This is the constant for creating world boundary shapes. A world boundary shape is an infinite line with an origin point, and a normal. Thus, it can be used for front/behind checks.
.. rst-class:: classref-enumeration-constant
:ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` SHAPE_SEPARATION_RAY = 1
This is the constant for creating separation ray shapes. A separation ray is defined by a length and separates itself from what is touching its far endpoint. Useful for character controllers.
.. rst-class:: classref-enumeration-constant
:ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` SHAPE_SEGMENT = 2
This is the constant for creating segment shapes. A segment shape is a finite line from a point A to a point B. It can be checked for intersections.
.. rst-class:: classref-enumeration-constant
:ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` SHAPE_CIRCLE = 3
This is the constant for creating circle shapes. A circle shape only has a radius. It can be used for intersections and inside/outside checks.
.. rst-class:: classref-enumeration-constant
:ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` SHAPE_RECTANGLE = 4
This is the constant for creating rectangle shapes. A rectangle shape is defined by a width and a height. It can be used for intersections and inside/outside checks.
.. rst-class:: classref-enumeration-constant
:ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` SHAPE_CAPSULE = 5
This is the constant for creating capsule shapes. A capsule shape is defined by a radius and a length. It can be used for intersections and inside/outside checks.
.. rst-class:: classref-enumeration-constant
:ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` SHAPE_CONVEX_POLYGON = 6
This is the constant for creating convex polygon shapes. A polygon is defined by a list of points. It can be used for intersections and inside/outside checks.
.. rst-class:: classref-enumeration-constant
:ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` SHAPE_CONCAVE_POLYGON = 7
This is the constant for creating concave polygon shapes. A polygon is defined by a list of points. It can be used for intersections checks, but not for inside/outside checks.
.. rst-class:: classref-enumeration-constant
:ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` SHAPE_CUSTOM = 8
This constant is used internally by the engine. Any attempt to create this kind of shape results in an error.
.. rst-class:: classref-item-separator
.. rst-class:: classref-enumeration
enum AreaParameter:
.. rst-class:: classref-enumeration-constant
:ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` AREA_PARAM_GRAVITY_OVERRIDE_MODE = 0
Constant to set/get gravity override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` for possible values. The default value of this parameter is :ref:`AREA_SPACE_OVERRIDE_DISABLED<class_PhysicsServer2D_constant_AREA_SPACE_OVERRIDE_DISABLED>`.
.. rst-class:: classref-enumeration-constant
:ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` AREA_PARAM_GRAVITY = 1
Constant to set/get gravity strength in an area. The default value of this parameter is 9.80665.
.. rst-class:: classref-enumeration-constant
:ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` AREA_PARAM_GRAVITY_VECTOR = 2
Constant to set/get gravity vector/center in an area. The default value of this parameter is Vector2(0, -1).
.. rst-class:: classref-enumeration-constant
:ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` AREA_PARAM_GRAVITY_IS_POINT = 3
Constant to set/get whether the gravity vector of an area is a direction, or a center point. The default value of this parameter is false.
.. rst-class:: classref-enumeration-constant
:ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` AREA_PARAM_GRAVITY_POINT_UNIT_DISTANCE = 4
Constant to set/get the distance at which the gravity strength is equal to the gravity controlled by :ref:`AREA_PARAM_GRAVITY<class_PhysicsServer2D_constant_AREA_PARAM_GRAVITY>`. For example, on a planet 100 pixels in radius with a surface gravity of 4.0 px/s², set the gravity to 4.0 and the unit distance to 100.0. The gravity will have falloff according to the inverse square law, so in the example, at 200 pixels from the center the gravity will be 1.0 px/s² (twice the distance, 1/4th the gravity), at 50 pixels it will be 16.0 px/s² (half the distance, 4x the gravity), and so on.
The above is true only when the unit distance is a positive number. When the unit distance is set to 0.0, the gravity will be constant regardless of distance. The default value of this parameter is 0.0.
.. rst-class:: classref-enumeration-constant
:ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE = 5
Constant to set/get linear damping override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` for possible values. The default value of this parameter is :ref:`AREA_SPACE_OVERRIDE_DISABLED<class_PhysicsServer2D_constant_AREA_SPACE_OVERRIDE_DISABLED>`.
.. rst-class:: classref-enumeration-constant
:ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` AREA_PARAM_LINEAR_DAMP = 6
Constant to set/get the linear damping factor of an area. The default value of this parameter is 0.1.
.. rst-class:: classref-enumeration-constant
:ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE = 7
Constant to set/get angular damping override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` for possible values. The default value of this parameter is :ref:`AREA_SPACE_OVERRIDE_DISABLED<class_PhysicsServer2D_constant_AREA_SPACE_OVERRIDE_DISABLED>`.
.. rst-class:: classref-enumeration-constant
:ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` AREA_PARAM_ANGULAR_DAMP = 8
Constant to set/get the angular damping factor of an area. The default value of this parameter is 1.0.
.. rst-class:: classref-enumeration-constant
:ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` AREA_PARAM_PRIORITY = 9
Constant to set/get the priority (order of processing) of an area. The default value of this parameter is 0.
.. rst-class:: classref-item-separator
.. rst-class:: classref-enumeration
enum AreaSpaceOverrideMode:
.. rst-class:: classref-enumeration-constant
:ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` AREA_SPACE_OVERRIDE_DISABLED = 0
This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
.. rst-class:: classref-enumeration-constant
:ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` AREA_SPACE_OVERRIDE_COMBINE = 1
This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects.
.. rst-class:: classref-enumeration-constant
:ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` AREA_SPACE_OVERRIDE_COMBINE_REPLACE = 2
This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one.
.. rst-class:: classref-enumeration-constant
:ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` AREA_SPACE_OVERRIDE_REPLACE = 3
This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
.. rst-class:: classref-enumeration-constant
:ref:`AreaSpaceOverrideMode<enum_PhysicsServer2D_AreaSpaceOverrideMode>` AREA_SPACE_OVERRIDE_REPLACE_COMBINE = 4
This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
.. rst-class:: classref-item-separator
.. rst-class:: classref-enumeration
enum BodyMode:
.. rst-class:: classref-enumeration-constant
:ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` BODY_MODE_STATIC = 0
Constant for static bodies. In this mode, a body can be only moved by user code and doesn't collide with other bodies along its path when moved.
.. rst-class:: classref-enumeration-constant
:ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` BODY_MODE_KINEMATIC = 1
Constant for kinematic bodies. In this mode, a body can be only moved by user code and collides with other bodies along its path.
.. rst-class:: classref-enumeration-constant
:ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` BODY_MODE_RIGID = 2
Constant for rigid bodies. In this mode, a body can be pushed by other bodies and has forces applied.
.. rst-class:: classref-enumeration-constant
:ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` BODY_MODE_RIGID_LINEAR = 3
Constant for linear rigid bodies. In this mode, a body can not rotate, and only its linear velocity is affected by external forces.
.. rst-class:: classref-item-separator
.. rst-class:: classref-enumeration
enum BodyParameter:
.. rst-class:: classref-enumeration-constant
:ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` BODY_PARAM_BOUNCE = 0
Constant to set/get a body's bounce factor. The default value of this parameter is 0.0.
.. rst-class:: classref-enumeration-constant
:ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` BODY_PARAM_FRICTION = 1
Constant to set/get a body's friction. The default value of this parameter is 1.0.
.. rst-class:: classref-enumeration-constant
:ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` BODY_PARAM_MASS = 2
Constant to set/get a body's mass. The default value of this parameter is 1.0. If the body's mode is set to :ref:`BODY_MODE_RIGID<class_PhysicsServer2D_constant_BODY_MODE_RIGID>`, then setting this parameter will have the following additional effects:
- If the parameter :ref:`BODY_PARAM_CENTER_OF_MASS<class_PhysicsServer2D_constant_BODY_PARAM_CENTER_OF_MASS>` has never been set explicitly, then the value of that parameter will be recalculated based on the body's shapes.
- If the parameter :ref:`BODY_PARAM_INERTIA<class_PhysicsServer2D_constant_BODY_PARAM_INERTIA>` is set to a value
<= 0.0, then the value of that parameter will be recalculated based on the body's shapes, mass, and center of mass.
.. rst-class:: classref-enumeration-constant
:ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` BODY_PARAM_INERTIA = 3
Constant to set/get a body's inertia. The default value of this parameter is 0.0. If the body's inertia is set to a value <= 0.0, then the inertia will be recalculated based on the body's shapes, mass, and center of mass.
.. rst-class:: classref-enumeration-constant
:ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` BODY_PARAM_CENTER_OF_MASS = 4
Constant to set/get a body's center of mass position in the body's local coordinate system. The default value of this parameter is Vector2(0,0). If this parameter is never set explicitly, then it is recalculated based on the body's shapes when setting the parameter :ref:`BODY_PARAM_MASS<class_PhysicsServer2D_constant_BODY_PARAM_MASS>` or when calling :ref:`body_set_space<class_PhysicsServer2D_method_body_set_space>`.
.. rst-class:: classref-enumeration-constant
:ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` BODY_PARAM_GRAVITY_SCALE = 5
Constant to set/get a body's gravity multiplier. The default value of this parameter is 1.0.
.. rst-class:: classref-enumeration-constant
:ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` BODY_PARAM_LINEAR_DAMP_MODE = 6
Constant to set/get a body's linear damping mode. See :ref:`BodyDampMode<enum_PhysicsServer2D_BodyDampMode>` for possible values. The default value of this parameter is :ref:`BODY_DAMP_MODE_COMBINE<class_PhysicsServer2D_constant_BODY_DAMP_MODE_COMBINE>`.
.. rst-class:: classref-enumeration-constant
:ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` BODY_PARAM_ANGULAR_DAMP_MODE = 7
Constant to set/get a body's angular damping mode. See :ref:`BodyDampMode<enum_PhysicsServer2D_BodyDampMode>` for possible values. The default value of this parameter is :ref:`BODY_DAMP_MODE_COMBINE<class_PhysicsServer2D_constant_BODY_DAMP_MODE_COMBINE>`.
.. rst-class:: classref-enumeration-constant
:ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` BODY_PARAM_LINEAR_DAMP = 8
Constant to set/get a body's linear damping factor. The default value of this parameter is 0.0.
.. rst-class:: classref-enumeration-constant
:ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` BODY_PARAM_ANGULAR_DAMP = 9
Constant to set/get a body's angular damping factor. The default value of this parameter is 0.0.
.. rst-class:: classref-enumeration-constant
:ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` BODY_PARAM_MAX = 10
Represents the size of the :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` enum.
.. rst-class:: classref-item-separator
.. rst-class:: classref-enumeration
enum BodyDampMode:
.. rst-class:: classref-enumeration-constant
:ref:`BodyDampMode<enum_PhysicsServer2D_BodyDampMode>` BODY_DAMP_MODE_COMBINE = 0
The body's damping value is added to any value set in areas or the default value.
.. rst-class:: classref-enumeration-constant
:ref:`BodyDampMode<enum_PhysicsServer2D_BodyDampMode>` BODY_DAMP_MODE_REPLACE = 1
The body's damping value replaces any value set in areas or the default value.
.. rst-class:: classref-item-separator
.. rst-class:: classref-enumeration
enum BodyState:
.. rst-class:: classref-enumeration-constant
:ref:`BodyState<enum_PhysicsServer2D_BodyState>` BODY_STATE_TRANSFORM = 0
Constant to set/get the current transform matrix of the body.
.. rst-class:: classref-enumeration-constant
:ref:`BodyState<enum_PhysicsServer2D_BodyState>` BODY_STATE_LINEAR_VELOCITY = 1
Constant to set/get the current linear velocity of the body.
.. rst-class:: classref-enumeration-constant
:ref:`BodyState<enum_PhysicsServer2D_BodyState>` BODY_STATE_ANGULAR_VELOCITY = 2
Constant to set/get the current angular velocity of the body.
.. rst-class:: classref-enumeration-constant
:ref:`BodyState<enum_PhysicsServer2D_BodyState>` BODY_STATE_SLEEPING = 3
Constant to sleep/wake up a body, or to get whether it is sleeping.
.. rst-class:: classref-enumeration-constant
:ref:`BodyState<enum_PhysicsServer2D_BodyState>` BODY_STATE_CAN_SLEEP = 4
Constant to set/get whether the body can sleep.
.. rst-class:: classref-item-separator
.. rst-class:: classref-enumeration
enum JointType:
.. rst-class:: classref-enumeration-constant
:ref:`JointType<enum_PhysicsServer2D_JointType>` JOINT_TYPE_PIN = 0
Constant to create pin joints.
.. rst-class:: classref-enumeration-constant
:ref:`JointType<enum_PhysicsServer2D_JointType>` JOINT_TYPE_GROOVE = 1
Constant to create groove joints.
.. rst-class:: classref-enumeration-constant
:ref:`JointType<enum_PhysicsServer2D_JointType>` JOINT_TYPE_DAMPED_SPRING = 2
Constant to create damped spring joints.
.. rst-class:: classref-enumeration-constant
:ref:`JointType<enum_PhysicsServer2D_JointType>` JOINT_TYPE_MAX = 3
Represents the size of the :ref:`JointType<enum_PhysicsServer2D_JointType>` enum.
.. rst-class:: classref-item-separator
.. rst-class:: classref-enumeration
enum JointParam:
.. rst-class:: classref-enumeration-constant
:ref:`JointParam<enum_PhysicsServer2D_JointParam>` JOINT_PARAM_BIAS = 0
Constant to set/get how fast the joint pulls the bodies back to satisfy the joint constraint. The lower the value, the more the two bodies can pull on the joint. The default value of this parameter is 0.0.
Note: In Godot Physics, this parameter is only used for pin joints and groove joints.
.. rst-class:: classref-enumeration-constant
:ref:`JointParam<enum_PhysicsServer2D_JointParam>` JOINT_PARAM_MAX_BIAS = 1
Constant to set/get the maximum speed with which the joint can apply corrections. The default value of this parameter is 3.40282e+38.
Note: In Godot Physics, this parameter is only used for groove joints.
.. rst-class:: classref-enumeration-constant
:ref:`JointParam<enum_PhysicsServer2D_JointParam>` JOINT_PARAM_MAX_FORCE = 2
Constant to set/get the maximum force that the joint can use to act on the two bodies. The default value of this parameter is 3.40282e+38.
Note: In Godot Physics, this parameter is only used for groove joints.
.. rst-class:: classref-item-separator
.. rst-class:: classref-enumeration
enum PinJointParam:
.. rst-class:: classref-enumeration-constant
:ref:`PinJointParam<enum_PhysicsServer2D_PinJointParam>` PIN_JOINT_SOFTNESS = 0
Constant to set/get a how much the bond of the pin joint can flex. The default value of this parameter is 0.0.
.. rst-class:: classref-item-separator
.. rst-class:: classref-enumeration
enum DampedSpringParam:
.. rst-class:: classref-enumeration-constant
:ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` DAMPED_SPRING_REST_LENGTH = 0
Sets the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. The default value of this parameter is the distance between the joint's anchor points.
.. rst-class:: classref-enumeration-constant
:ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` DAMPED_SPRING_STIFFNESS = 1
Sets the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. The default value of this parameter is 20.0.
.. rst-class:: classref-enumeration-constant
:ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` DAMPED_SPRING_DAMPING = 2
Sets the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping). The default value of this parameter is 1.5.
.. rst-class:: classref-item-separator
.. rst-class:: classref-enumeration
enum CCDMode:
.. rst-class:: classref-enumeration-constant
:ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` CCD_MODE_DISABLED = 0
Disables continuous collision detection. This is the fastest way to detect body collisions, but it can miss small and/or fast-moving objects.
.. rst-class:: classref-enumeration-constant
:ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` CCD_MODE_CAST_RAY = 1
Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise.
.. rst-class:: classref-enumeration-constant
:ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` CCD_MODE_CAST_SHAPE = 2
Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise.
.. rst-class:: classref-item-separator
.. rst-class:: classref-enumeration
enum AreaBodyStatus:
.. rst-class:: classref-enumeration-constant
:ref:`AreaBodyStatus<enum_PhysicsServer2D_AreaBodyStatus>` AREA_BODY_ADDED = 0
The value of the first parameter and area callback function receives, when an object enters one of its shapes.
.. rst-class:: classref-enumeration-constant
:ref:`AreaBodyStatus<enum_PhysicsServer2D_AreaBodyStatus>` AREA_BODY_REMOVED = 1
The value of the first parameter and area callback function receives, when an object exits one of its shapes.
.. rst-class:: classref-item-separator
.. rst-class:: classref-enumeration
enum ProcessInfo:
.. rst-class:: classref-enumeration-constant
:ref:`ProcessInfo<enum_PhysicsServer2D_ProcessInfo>` INFO_ACTIVE_OBJECTS = 0
Constant to get the number of objects that are not sleeping.
.. rst-class:: classref-enumeration-constant
:ref:`ProcessInfo<enum_PhysicsServer2D_ProcessInfo>` INFO_COLLISION_PAIRS = 1
Constant to get the number of possible collisions.
.. rst-class:: classref-enumeration-constant
:ref:`ProcessInfo<enum_PhysicsServer2D_ProcessInfo>` INFO_ISLAND_COUNT = 2
Constant to get the number of space regions where a collision could occur.
.. rst-class:: classref-section-separator
.. rst-class:: classref-descriptions-group
.. rst-class:: classref-method
void area_add_shape ( :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` shape, :ref:`Transform2D<class_Transform2D>` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`bool<class_bool>` disabled=false )
Adds a shape to the area, with the given local transform. The shape (together with its transform and disabled properties) is added to an array of shapes, and the shapes of an area are usually referenced by their index in this array.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void area_attach_canvas_instance_id ( :ref:`RID<class_RID>` area, :ref:`int<class_int>` id )
Attaches the ObjectID of a canvas to the area. Use :ref:`Object.get_instance_id<class_Object_method_get_instance_id>` to get the ObjectID of a :ref:`CanvasLayer<class_CanvasLayer>`.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void area_attach_object_instance_id ( :ref:`RID<class_RID>` area, :ref:`int<class_int>` id )
Attaches the ObjectID of an :ref:`Object<class_Object>` to the area. Use :ref:`Object.get_instance_id<class_Object_method_get_instance_id>` to get the ObjectID of a :ref:`CollisionObject2D<class_CollisionObject2D>`.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void area_clear_shapes ( :ref:`RID<class_RID>` area )
Removes all shapes from the area. This does not delete the shapes themselves, so they can continue to be used elsewhere or added back later.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`RID<class_RID>` area_create ( )
Creates a 2D area object in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. Use :ref:`area_add_shape<class_PhysicsServer2D_method_area_add_shape>` to add shapes to it, use :ref:`area_set_transform<class_PhysicsServer2D_method_area_set_transform>` to set its transform, and use :ref:`area_set_space<class_PhysicsServer2D_method_area_set_space>` to add the area to a space.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`int<class_int>` area_get_canvas_instance_id ( :ref:`RID<class_RID>` area ) |const|
Returns the ObjectID of the canvas attached to the area. Use :ref:`@GlobalScope.instance_from_id<class_@GlobalScope_method_instance_from_id>` to retrieve a :ref:`CanvasLayer<class_CanvasLayer>` from a nonzero ObjectID.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`int<class_int>` area_get_collision_layer ( :ref:`RID<class_RID>` area ) |const|
Returns the physics layer or layers the area belongs to, as a bitmask.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`int<class_int>` area_get_collision_mask ( :ref:`RID<class_RID>` area ) |const|
Returns the physics layer or layers the area can contact with, as a bitmask.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`int<class_int>` area_get_object_instance_id ( :ref:`RID<class_RID>` area ) |const|
Returns the ObjectID attached to the area. Use :ref:`@GlobalScope.instance_from_id<class_@GlobalScope_method_instance_from_id>` to retrieve an :ref:`Object<class_Object>` from a nonzero ObjectID.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`Variant<class_Variant>` area_get_param ( :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` param ) |const|
Returns the value of the given area parameter. See :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` for the list of available parameters.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`RID<class_RID>` area_get_shape ( :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx ) |const|
Returns the :ref:`RID<class_RID>` of the shape with the given index in the area's array of shapes.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`int<class_int>` area_get_shape_count ( :ref:`RID<class_RID>` area ) |const|
Returns the number of shapes added to the area.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`Transform2D<class_Transform2D>` area_get_shape_transform ( :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx ) |const|
Returns the local transform matrix of the shape with the given index in the area's array of shapes.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`RID<class_RID>` area_get_space ( :ref:`RID<class_RID>` area ) |const|
Returns the :ref:`RID<class_RID>` of the space assigned to the area. Returns RID() if no space is assigned.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`Transform2D<class_Transform2D>` area_get_transform ( :ref:`RID<class_RID>` area ) |const|
Returns the transform matrix of the area.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void area_remove_shape ( :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx )
Removes the shape with the given index from the area's array of shapes. The shape itself is not deleted, so it can continue to be used elsewhere or added back later. As a result of this operation, the area's shapes which used to have indices higher than shape_idx will have their index decreased by one.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void area_set_area_monitor_callback ( :ref:`RID<class_RID>` area, :ref:`Callable<class_Callable>` callback )
Sets the area's area monitor callback. This callback will be called when any other (shape of an) area enters or exits (a shape of) the given area, and must take the following five parameters:
- an integer
status: either :ref:`AREA_BODY_ADDED<class_PhysicsServer2D_constant_AREA_BODY_ADDED>` or :ref:`AREA_BODY_REMOVED<class_PhysicsServer2D_constant_AREA_BODY_REMOVED>` depending on whether the other area's shape entered or exited the area, - an :ref:`RID<class_RID>`
area_rid: the :ref:`RID<class_RID>` of the other area that entered or exited the area, - an integer
instance_id: theObjectIDattached to the other area, - an integer
area_shape_idx: the index of the shape of the other area that entered or exited the area, - an integer
self_shape_idx: the index of the shape of the area where the other area entered or exited.
By counting (or keeping track of) the shapes that enter and exit, it can be determined if an area (with all its shapes) is entering for the first time or exiting for the last time.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void area_set_collision_layer ( :ref:`RID<class_RID>` area, :ref:`int<class_int>` layer )
Assigns the area to one or many physics layers, via a bitmask.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void area_set_collision_mask ( :ref:`RID<class_RID>` area, :ref:`int<class_int>` mask )
Sets which physics layers the area will monitor, via a bitmask.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void area_set_monitor_callback ( :ref:`RID<class_RID>` area, :ref:`Callable<class_Callable>` callback )
Sets the area's body monitor callback. This callback will be called when any other (shape of a) body enters or exits (a shape of) the given area, and must take the following five parameters:
- an integer
status: either :ref:`AREA_BODY_ADDED<class_PhysicsServer2D_constant_AREA_BODY_ADDED>` or :ref:`AREA_BODY_REMOVED<class_PhysicsServer2D_constant_AREA_BODY_REMOVED>` depending on whether the other body shape entered or exited the area, - an :ref:`RID<class_RID>`
body_rid: the :ref:`RID<class_RID>` of the body that entered or exited the area, - an integer
instance_id: theObjectIDattached to the body, - an integer
body_shape_idx: the index of the shape of the body that entered or exited the area, - an integer
self_shape_idx: the index of the shape of the area where the body entered or exited.
By counting (or keeping track of) the shapes that enter and exit, it can be determined if a body (with all its shapes) is entering for the first time or exiting for the last time.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void area_set_monitorable ( :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` monitorable )
Sets whether the area is monitorable or not. If monitorable is true, the area monitoring callback of other areas will be called when this area enters or exits them.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void area_set_param ( :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` param, :ref:`Variant<class_Variant>` value )
Sets the value of the given area parameter. See :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` for the list of available parameters.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void area_set_shape ( :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape )
Replaces the area's shape at the given index by another shape, while not affecting the transform and disabled properties at the same index.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void area_set_shape_disabled ( :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled )
Sets the disabled property of the area's shape with the given index. If disabled is true, then the shape will not detect any other shapes entering or exiting it.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void area_set_shape_transform ( :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_Transform2D>` transform )
Sets the local transform matrix of the area's shape with the given index.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void area_set_space ( :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` space )
Adds the area to the given space, after removing the area from the previously assigned space (if any).
Note: To remove an area from a space without immediately adding it back elsewhere, use PhysicsServer2D.area_set_space(area, RID()).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void area_set_transform ( :ref:`RID<class_RID>` area, :ref:`Transform2D<class_Transform2D>` transform )
Sets the transform matrix of the area.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_add_collision_exception ( :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body )
Adds excepted_body to the body's list of collision exceptions, so that collisions with it are ignored.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_add_constant_central_force ( :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force )
Adds a constant directional force to the body. The force does not affect rotation. The force remains applied over time until cleared with PhysicsServer2D.body_set_constant_force(body, Vector2(0, 0)).
This is equivalent to using :ref:`body_add_constant_force<class_PhysicsServer2D_method_body_add_constant_force>` at the body's center of mass.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_add_constant_force ( :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force, :ref:`Vector2<class_Vector2>` position=Vector2(0, 0) )
Adds a constant positioned force to the body. The force can affect rotation if position is different from the body's center of mass. The force remains applied over time until cleared with PhysicsServer2D.body_set_constant_force(body, Vector2(0, 0)).
position is the offset from the body origin in global coordinates.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_add_constant_torque ( :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque )
Adds a constant rotational force to the body. The force does not affect position. The force remains applied over time until cleared with PhysicsServer2D.body_set_constant_torque(body, 0).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_add_shape ( :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` shape, :ref:`Transform2D<class_Transform2D>` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`bool<class_bool>` disabled=false )
Adds a shape to the area, with the given local transform. The shape (together with its transform and disabled properties) is added to an array of shapes, and the shapes of a body are usually referenced by their index in this array.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_apply_central_force ( :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force )
Applies a directional force to the body, at the body's center of mass. The force does not affect rotation. A force is time dependent and meant to be applied every physics update.
This is equivalent to using :ref:`body_apply_force<class_PhysicsServer2D_method_body_apply_force>` at the body's center of mass.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_apply_central_impulse ( :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` impulse )
Applies a directional impulse to the body, at the body's center of mass. The impulse does not affect rotation.
An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
This is equivalent to using :ref:`body_apply_impulse<class_PhysicsServer2D_method_body_apply_impulse>` at the body's center of mass.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_apply_force ( :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force, :ref:`Vector2<class_Vector2>` position=Vector2(0, 0) )
Applies a positioned force to the body. The force can affect rotation if position is different from the body's center of mass. 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
.. rst-class:: classref-method
void body_apply_impulse ( :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` impulse, :ref:`Vector2<class_Vector2>` position=Vector2(0, 0) )
Applies a positioned impulse to the body. The impulse can affect rotation if position is different from the body's center of mass.
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
.. rst-class:: classref-method
void body_apply_torque ( :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque )
Applies a rotational force to the body. The force does not affect position. A force is time dependent and meant to be applied every physics update.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_apply_torque_impulse ( :ref:`RID<class_RID>` body, :ref:`float<class_float>` impulse )
Applies a rotational impulse to the body. The impulse does not affect 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
.. rst-class:: classref-method
void body_attach_canvas_instance_id ( :ref:`RID<class_RID>` body, :ref:`int<class_int>` id )
Attaches the ObjectID of a canvas to the body. Use :ref:`Object.get_instance_id<class_Object_method_get_instance_id>` to get the ObjectID of a :ref:`CanvasLayer<class_CanvasLayer>`.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_attach_object_instance_id ( :ref:`RID<class_RID>` body, :ref:`int<class_int>` id )
Attaches the ObjectID of an :ref:`Object<class_Object>` to the body. Use :ref:`Object.get_instance_id<class_Object_method_get_instance_id>` to get the ObjectID of a :ref:`CollisionObject2D<class_CollisionObject2D>`.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_clear_shapes ( :ref:`RID<class_RID>` body )
Removes all shapes from the body. This does not delete the shapes themselves, so they can continue to be used elsewhere or added back later.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`RID<class_RID>` body_create ( )
Creates a 2D body object in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. Use :ref:`body_add_shape<class_PhysicsServer2D_method_body_add_shape>` to add shapes to it, use :ref:`body_set_state<class_PhysicsServer2D_method_body_set_state>` to set its transform, and use :ref:`body_set_space<class_PhysicsServer2D_method_body_set_space>` to add the body to a space.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`int<class_int>` body_get_canvas_instance_id ( :ref:`RID<class_RID>` body ) |const|
Returns the ObjectID of the canvas attached to the body. Use :ref:`@GlobalScope.instance_from_id<class_@GlobalScope_method_instance_from_id>` to retrieve a :ref:`CanvasLayer<class_CanvasLayer>` from a nonzero ObjectID.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`int<class_int>` body_get_collision_layer ( :ref:`RID<class_RID>` body ) |const|
Returns the physics layer or layers the body belongs to, as a bitmask.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`int<class_int>` body_get_collision_mask ( :ref:`RID<class_RID>` body ) |const|
Returns the physics layer or layers the body can collide with, as a bitmask.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`float<class_float>` body_get_collision_priority ( :ref:`RID<class_RID>` body ) |const|
Returns the body's collision priority. This is used in the depenetration phase of :ref:`body_test_motion<class_PhysicsServer2D_method_body_test_motion>`. The higher the priority is, the lower the penetration into the body will be.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`Vector2<class_Vector2>` body_get_constant_force ( :ref:`RID<class_RID>` body ) |const|
Returns the body's total constant positional force applied during each physics update.
See :ref:`body_add_constant_force<class_PhysicsServer2D_method_body_add_constant_force>` and :ref:`body_add_constant_central_force<class_PhysicsServer2D_method_body_add_constant_central_force>`.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`float<class_float>` body_get_constant_torque ( :ref:`RID<class_RID>` body ) |const|
Returns the body's total constant rotational force applied during each physics update.
See :ref:`body_add_constant_torque<class_PhysicsServer2D_method_body_add_constant_torque>`.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` body_get_continuous_collision_detection_mode ( :ref:`RID<class_RID>` body ) |const|
Returns the body's continuous collision detection mode (see :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>`).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`PhysicsDirectBodyState2D<class_PhysicsDirectBodyState2D>` body_get_direct_state ( :ref:`RID<class_RID>` body )
Returns the :ref:`PhysicsDirectBodyState2D<class_PhysicsDirectBodyState2D>` of the body. Returns null if the body is destroyed or not assigned to a space.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`int<class_int>` body_get_max_contacts_reported ( :ref:`RID<class_RID>` body ) |const|
Returns the maximum number of contacts that the body can report. See :ref:`body_set_max_contacts_reported<class_PhysicsServer2D_method_body_set_max_contacts_reported>`.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` body_get_mode ( :ref:`RID<class_RID>` body ) |const|
Returns the body's mode (see :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>`).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`int<class_int>` body_get_object_instance_id ( :ref:`RID<class_RID>` body ) |const|
Returns the ObjectID attached to the body. Use :ref:`@GlobalScope.instance_from_id<class_@GlobalScope_method_instance_from_id>` to retrieve an :ref:`Object<class_Object>` from a nonzero ObjectID.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`Variant<class_Variant>` body_get_param ( :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` param ) |const|
Returns the value of the given body parameter. See :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` for the list of available parameters.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`RID<class_RID>` body_get_shape ( :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx ) |const|
Returns the :ref:`RID<class_RID>` of the shape with the given index in the body's array of shapes.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`int<class_int>` body_get_shape_count ( :ref:`RID<class_RID>` body ) |const|
Returns the number of shapes added to the body.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`Transform2D<class_Transform2D>` body_get_shape_transform ( :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx ) |const|
Returns the local transform matrix of the shape with the given index in the area's array of shapes.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`RID<class_RID>` body_get_space ( :ref:`RID<class_RID>` body ) |const|
Returns the :ref:`RID<class_RID>` of the space assigned to the body. Returns RID() if no space is assigned.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`Variant<class_Variant>` body_get_state ( :ref:`RID<class_RID>` body, :ref:`BodyState<enum_PhysicsServer2D_BodyState>` state ) |const|
Returns the value of the given state of the body. See :ref:`BodyState<enum_PhysicsServer2D_BodyState>` for the list of available states.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`bool<class_bool>` body_is_omitting_force_integration ( :ref:`RID<class_RID>` body ) |const|
Returns true if the body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback<class_PhysicsServer2D_method_body_set_force_integration_callback>`).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_remove_collision_exception ( :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body )
Removes excepted_body from the body's list of collision exceptions, so that collisions with it are no longer ignored.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_remove_shape ( :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx )
Removes the shape with the given index from the body's array of shapes. The shape itself is not deleted, so it can continue to be used elsewhere or added back later. As a result of this operation, the body's shapes which used to have indices higher than shape_idx will have their index decreased by one.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_reset_mass_properties ( :ref:`RID<class_RID>` body )
Restores the default inertia and center of mass of the body based on its shapes. This undoes any custom values previously set using :ref:`body_set_param<class_PhysicsServer2D_method_body_set_param>`.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_set_axis_velocity ( :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` axis_velocity )
Modifies the body's linear velocity so that its projection to the axis axis_velocity.normalized() is exactly axis_velocity.length(). This is useful for jumping behavior.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_set_collision_layer ( :ref:`RID<class_RID>` body, :ref:`int<class_int>` layer )
Sets the physics layer or layers the body belongs to, via a bitmask.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_set_collision_mask ( :ref:`RID<class_RID>` body, :ref:`int<class_int>` mask )
Sets the physics layer or layers the body can collide with, via a bitmask.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_set_collision_priority ( :ref:`RID<class_RID>` body, :ref:`float<class_float>` priority )
Sets the body's collision priority. This is used in the depenetration phase of :ref:`body_test_motion<class_PhysicsServer2D_method_body_test_motion>`. The higher the priority is, the lower the penetration into the body will be.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_set_constant_force ( :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force )
Sets the body's total constant positional force applied during each physics update.
See :ref:`body_add_constant_force<class_PhysicsServer2D_method_body_add_constant_force>` and :ref:`body_add_constant_central_force<class_PhysicsServer2D_method_body_add_constant_central_force>`.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_set_constant_torque ( :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque )
Sets the body's total constant rotational force applied during each physics update.
See :ref:`body_add_constant_torque<class_PhysicsServer2D_method_body_add_constant_torque>`.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_set_continuous_collision_detection_mode ( :ref:`RID<class_RID>` body, :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` mode )
Sets the continuous collision detection mode using one of the :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` constants.
Continuous collision detection tries to predict where a moving body would collide in between physics updates, instead of moving it and correcting its movement if it collided.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_set_force_integration_callback ( :ref:`RID<class_RID>` body, :ref:`Callable<class_Callable>` callable, :ref:`Variant<class_Variant>` userdata=null )
Sets the function used to calculate physics for the body, if that body allows it (see :ref:`body_set_omit_force_integration<class_PhysicsServer2D_method_body_set_omit_force_integration>`).
The force integration function takes the following two parameters:
- a :ref:`PhysicsDirectBodyState2D<class_PhysicsDirectBodyState2D>`
state: used to retrieve and modify the body's state, - a :ref:`Variant<class_Variant>`
userdata: optional user data.
Note: This callback is currently not called in Godot Physics.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_set_max_contacts_reported ( :ref:`RID<class_RID>` body, :ref:`int<class_int>` amount )
Sets the maximum number of contacts that the body can report. If amount is greater than zero, then the body will keep track of at most this many contacts with other bodies.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_set_mode ( :ref:`RID<class_RID>` body, :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` mode )
Sets the body's mode. See :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` for the list of available modes.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_set_omit_force_integration ( :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable )
Sets whether the body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback<class_PhysicsServer2D_method_body_set_force_integration_callback>`).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_set_param ( :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` param, :ref:`Variant<class_Variant>` value )
Sets the value of the given body parameter. See :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` for the list of available parameters.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_set_shape ( :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape )
Replaces the body's shape at the given index by another shape, while not affecting the transform, disabled, and one-way collision properties at the same index.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_set_shape_as_one_way_collision ( :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` margin )
Sets the one-way collision properties of the body's shape with the given index. If enable is true, the one-way collision direction given by the shape's local upward axis body_get_shape_transform(body, shape_idx).y will be used to ignore collisions with the shape in the opposite direction, and to ensure depenetration of kinematic bodies happens in this direction.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_set_shape_disabled ( :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled )
Sets the disabled property of the body's shape with the given index. If disabled is true, then the shape will be ignored in all collision detection.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_set_shape_transform ( :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_Transform2D>` transform )
Sets the local transform matrix of the body's shape with the given index.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_set_space ( :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` space )
Adds the body to the given space, after removing the body from the previously assigned space (if any). If the body's mode is set to :ref:`BODY_MODE_RIGID<class_PhysicsServer2D_constant_BODY_MODE_RIGID>`, then adding the body to a space will have the following additional effects:
- If the parameter :ref:`BODY_PARAM_CENTER_OF_MASS<class_PhysicsServer2D_constant_BODY_PARAM_CENTER_OF_MASS>` has never been set explicitly, then the value of that parameter will be recalculated based on the body's shapes.
- If the parameter :ref:`BODY_PARAM_INERTIA<class_PhysicsServer2D_constant_BODY_PARAM_INERTIA>` is set to a value
<= 0.0, then the value of that parameter will be recalculated based on the body's shapes, mass, and center of mass.
Note: To remove a body from a space without immediately adding it back elsewhere, use PhysicsServer2D.body_set_space(body, RID()).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void body_set_state ( :ref:`RID<class_RID>` body, :ref:`BodyState<enum_PhysicsServer2D_BodyState>` state, :ref:`Variant<class_Variant>` value )
Sets the value of a body's state. See :ref:`BodyState<enum_PhysicsServer2D_BodyState>` for the list of available states.
Note: The state change doesn't take effect immediately. The state will change on the next physics frame.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`bool<class_bool>` body_test_motion ( :ref:`RID<class_RID>` body, :ref:`PhysicsTestMotionParameters2D<class_PhysicsTestMotionParameters2D>` parameters, :ref:`PhysicsTestMotionResult2D<class_PhysicsTestMotionResult2D>` result=null )
Returns true if a collision would result from moving the body along a motion vector from a given point in space. See :ref:`PhysicsTestMotionParameters2D<class_PhysicsTestMotionParameters2D>` for the available motion parameters. Optionally a :ref:`PhysicsTestMotionResult2D<class_PhysicsTestMotionResult2D>` object can be passed, which will be used to store the information about the resulting collision.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`RID<class_RID>` capsule_shape_create ( )
Creates a 2D capsule shape in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. Use :ref:`shape_set_data<class_PhysicsServer2D_method_shape_set_data>` to set the capsule's height and radius.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`RID<class_RID>` circle_shape_create ( )
Creates a 2D circle shape in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. Use :ref:`shape_set_data<class_PhysicsServer2D_method_shape_set_data>` to set the circle's radius.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`RID<class_RID>` concave_polygon_shape_create ( )
Creates a 2D concave polygon shape in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. Use :ref:`shape_set_data<class_PhysicsServer2D_method_shape_set_data>` to set the concave polygon's segments.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`RID<class_RID>` convex_polygon_shape_create ( )
Creates a 2D convex polygon shape in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. Use :ref:`shape_set_data<class_PhysicsServer2D_method_shape_set_data>` to set the convex polygon's points.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`float<class_float>` damped_spring_joint_get_param ( :ref:`RID<class_RID>` joint, :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` param ) |const|
Returns the value of the given damped spring joint parameter. See :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` for the list of available parameters.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void damped_spring_joint_set_param ( :ref:`RID<class_RID>` joint, :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` param, :ref:`float<class_float>` value )
Sets the value of the given damped spring joint parameter. See :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` for the list of available parameters.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void free_rid ( :ref:`RID<class_RID>` rid )
Destroys any of the objects created by PhysicsServer2D. If the :ref:`RID<class_RID>` passed is not one of the objects that can be created by PhysicsServer2D, an error will be printed to the console.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`int<class_int>` get_process_info ( :ref:`ProcessInfo<enum_PhysicsServer2D_ProcessInfo>` process_info )
Returns information about the current state of the 2D physics engine. See :ref:`ProcessInfo<enum_PhysicsServer2D_ProcessInfo>` for the list of available states.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void joint_clear ( :ref:`RID<class_RID>` joint )
Destroys the joint with the given :ref:`RID<class_RID>`, creates a new uninitialized joint, and makes the :ref:`RID<class_RID>` refer to this new joint.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`RID<class_RID>` joint_create ( )
Creates a 2D joint in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. To set the joint type, use :ref:`joint_make_damped_spring<class_PhysicsServer2D_method_joint_make_damped_spring>`, :ref:`joint_make_groove<class_PhysicsServer2D_method_joint_make_groove>` or :ref:`joint_make_pin<class_PhysicsServer2D_method_joint_make_pin>`. Use :ref:`joint_set_param<class_PhysicsServer2D_method_joint_set_param>` to set generic joint parameters.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void joint_disable_collisions_between_bodies ( :ref:`RID<class_RID>` joint, :ref:`bool<class_bool>` disable )
Sets whether the bodies attached to the :ref:`Joint2D<class_Joint2D>` will collide with each other.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`float<class_float>` joint_get_param ( :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_PhysicsServer2D_JointParam>` param ) |const|
Returns the value of the given joint parameter. See :ref:`JointParam<enum_PhysicsServer2D_JointParam>` for the list of available parameters.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`JointType<enum_PhysicsServer2D_JointType>` joint_get_type ( :ref:`RID<class_RID>` joint ) |const|
Returns the joint's type (see :ref:`JointType<enum_PhysicsServer2D_JointType>`).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`bool<class_bool>` joint_is_disabled_collisions_between_bodies ( :ref:`RID<class_RID>` joint ) |const|
Returns whether the bodies attached to the :ref:`Joint2D<class_Joint2D>` will collide with each other.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void joint_make_damped_spring ( :ref:`RID<class_RID>` joint, :ref:`Vector2<class_Vector2>` anchor_a, :ref:`Vector2<class_Vector2>` anchor_b, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b=RID() )
Makes the joint a damped spring joint, attached at the point anchor_a (given in global coordinates) on the body body_a and at the point anchor_b (given in global coordinates) on the body body_b. To set the parameters which are specific to the damped spring, see :ref:`damped_spring_joint_set_param<class_PhysicsServer2D_method_damped_spring_joint_set_param>`.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void joint_make_groove ( :ref:`RID<class_RID>` joint, :ref:`Vector2<class_Vector2>` groove1_a, :ref:`Vector2<class_Vector2>` groove2_a, :ref:`Vector2<class_Vector2>` anchor_b, :ref:`RID<class_RID>` body_a=RID(), :ref:`RID<class_RID>` body_b=RID() )
Makes the joint a groove joint.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void joint_make_pin ( :ref:`RID<class_RID>` joint, :ref:`Vector2<class_Vector2>` anchor, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b=RID() )
Makes the joint a pin joint. If body_b is RID(), then body_a is pinned to the point anchor (given in global coordinates); otherwise, body_a is pinned to body_b at the point anchor (given in global coordinates). To set the parameters which are specific to the pin joint, see :ref:`pin_joint_set_param<class_PhysicsServer2D_method_pin_joint_set_param>`.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void joint_set_param ( :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_PhysicsServer2D_JointParam>` param, :ref:`float<class_float>` value )
Sets the value of the given joint parameter. See :ref:`JointParam<enum_PhysicsServer2D_JointParam>` for the list of available parameters.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`float<class_float>` pin_joint_get_param ( :ref:`RID<class_RID>` joint, :ref:`PinJointParam<enum_PhysicsServer2D_PinJointParam>` param ) |const|
Returns the value of a pin joint parameter. See :ref:`PinJointParam<enum_PhysicsServer2D_PinJointParam>` for a list of available parameters.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void pin_joint_set_param ( :ref:`RID<class_RID>` joint, :ref:`PinJointParam<enum_PhysicsServer2D_PinJointParam>` param, :ref:`float<class_float>` value )
Sets a pin joint parameter. See :ref:`PinJointParam<enum_PhysicsServer2D_PinJointParam>` for a list of available parameters.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`RID<class_RID>` rectangle_shape_create ( )
Creates a 2D rectangle shape in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. Use :ref:`shape_set_data<class_PhysicsServer2D_method_shape_set_data>` to set the rectangle's half-extents.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`RID<class_RID>` segment_shape_create ( )
Creates a 2D segment shape in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. Use :ref:`shape_set_data<class_PhysicsServer2D_method_shape_set_data>` to set the segment's start and end points.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`RID<class_RID>` separation_ray_shape_create ( )
Creates a 2D separation ray shape in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. Use :ref:`shape_set_data<class_PhysicsServer2D_method_shape_set_data>` to set the shape's length and slide_on_slope properties.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void set_active ( :ref:`bool<class_bool>` active )
Activates or deactivates the 2D physics server. If active is false, then the physics server will not do anything in its physics step.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`Variant<class_Variant>` shape_get_data ( :ref:`RID<class_RID>` shape ) |const|
Returns the shape data that defines the configuration of the shape, such as the half-extents of a rectangle or the segments of a concave shape. See :ref:`shape_set_data<class_PhysicsServer2D_method_shape_set_data>` for the precise format of this data in each case.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` shape_get_type ( :ref:`RID<class_RID>` shape ) |const|
Returns the shape's type (see :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>`).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void shape_set_data ( :ref:`RID<class_RID>` shape, :ref:`Variant<class_Variant>` data )
Sets the shape data that defines the configuration of the shape. The data to be passed depends on the shape's type (see :ref:`shape_get_type<class_PhysicsServer2D_method_shape_get_type>`):
- :ref:`SHAPE_WORLD_BOUNDARY<class_PhysicsServer2D_constant_SHAPE_WORLD_BOUNDARY>`: an array of length two containing a :ref:`Vector2<class_Vector2>`
normaldirection and afloatdistanced, - :ref:`SHAPE_SEPARATION_RAY<class_PhysicsServer2D_constant_SHAPE_SEPARATION_RAY>`: a dictionary containing the key
lengthwith afloatvalue and the keyslide_on_slopewith aboolvalue, - :ref:`SHAPE_SEGMENT<class_PhysicsServer2D_constant_SHAPE_SEGMENT>`: a :ref:`Rect2<class_Rect2>`
rectcontaining the first point of the segment inrect.positionand the second point of the segment inrect.size, - :ref:`SHAPE_CIRCLE<class_PhysicsServer2D_constant_SHAPE_CIRCLE>`: a
floatradius, - :ref:`SHAPE_RECTANGLE<class_PhysicsServer2D_constant_SHAPE_RECTANGLE>`: a :ref:`Vector2<class_Vector2>`
half_extents, - :ref:`SHAPE_CAPSULE<class_PhysicsServer2D_constant_SHAPE_CAPSULE>`: an array of length two (or a :ref:`Vector2<class_Vector2>`) containing a
floatheightand afloatradius, - :ref:`SHAPE_CONVEX_POLYGON<class_PhysicsServer2D_constant_SHAPE_CONVEX_POLYGON>`: either a :ref:`PackedVector2Array<class_PackedVector2Array>` of points defining a convex polygon in counterclockwise order (the clockwise outward normal of each segment formed by consecutive points is calculated internally), or a :ref:`PackedFloat32Array<class_PackedFloat32Array>` of length divisible by four so that every 4-tuple of
floats contains the coordinates of a point followed by the coordinates of the clockwise outward normal vector to the segment between the current point and the next point, - :ref:`SHAPE_CONCAVE_POLYGON<class_PhysicsServer2D_constant_SHAPE_CONCAVE_POLYGON>`: a :ref:`PackedVector2Array<class_PackedVector2Array>` of length divisible by two (each pair of points forms one segment).
Warning: In the case of :ref:`SHAPE_CONVEX_POLYGON<class_PhysicsServer2D_constant_SHAPE_CONVEX_POLYGON>`, this method does not check if the points supplied actually form a convex polygon (unlike the :ref:`CollisionPolygon2D.polygon<class_CollisionPolygon2D_property_polygon>` property).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`RID<class_RID>` space_create ( )
Creates a 2D space in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. A space contains bodies and areas, and controls the stepping of the physics simulation of the objects in it.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`PhysicsDirectSpaceState2D<class_PhysicsDirectSpaceState2D>` space_get_direct_state ( :ref:`RID<class_RID>` space )
Returns the state of a space, a :ref:`PhysicsDirectSpaceState2D<class_PhysicsDirectSpaceState2D>`. This object can be used for collision/intersection queries.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`float<class_float>` space_get_param ( :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` param ) |const|
Returns the value of the given space parameter. See :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` for the list of available parameters.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`bool<class_bool>` space_is_active ( :ref:`RID<class_RID>` space ) |const|
Returns true if the space is active.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void space_set_active ( :ref:`RID<class_RID>` space, :ref:`bool<class_bool>` active )
Activates or deactivates the space. If active is false, then the physics server will not do anything with this space in its physics step.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void space_set_param ( :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` param, :ref:`float<class_float>` value )
Sets the value of the given space parameter. See :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` for the list of available parameters.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`RID<class_RID>` world_boundary_shape_create ( )
Creates a 2D world boundary shape in the physics server, and returns the :ref:`RID<class_RID>` that identifies it. Use :ref:`shape_set_data<class_PhysicsServer2D_method_shape_set_data>` to set the shape's normal direction and distance properties.